Browse Source

add README file

mxmehl 3 years ago
parent
commit
0282a1f67b
1 changed files with 33 additions and 0 deletions
  1. 33
    0
      README.md

+ 33
- 0
README.md View File

@@ -0,0 +1,33 @@
1
+# Uberspace Account Administration Panel (UAAP)
2
+
3
+**UAAP** is a PHP and Bash based webpanel to administrate an Uberspace.de user. Uberspace is a popular German webhosting provider which focusses on fair prices, privacy and Free Software.
4
+
5
+## Features
6
+
7
+With UAAP, you or your clients are able to execute commands on an Uberspace account very easily. For example:
8
+
9
+* Show a data sheet (works best when installed by uberspace-setup)
10
+* Show disk quotas
11
+* Show size of email accounts
12
+* Create new email or alias accounts
13
+* Show detail infos for email accounts
14
+* Delete email accounts
15
+* Automatic tracking of changed email passwords in the data sheet (when installed with uberspace-setup)
16
+* Install (and uninstall) WordPress automatically
17
+
18
+The design and workflow is designed to be as simple as possible. However, UAAP offers multiple languages. Currently it supports English and German but additional languages can be added easily.
19
+
20
+## Installation
21
+
22
+### Method uberspace-setup (recommended)
23
+
24
+It's recommended to install UAAP automatically by using another script of mine, [uberspace-setup](http://src.mehl.mx/uberspace-setup.git), which sets up an Uberspace account quite easily. This process also creates the data sheet which can then be viewed at on UAAP. Using this method also enables UAAP to track email password changes automatically!
25
+
26
+### Manual method (not recommended, needs more work)
27
+
28
+Download the git repository by using 
29
+`git clone http://src.mehl.mx/git/uberspace-setup.git`
30
+
31
+I assume it's best to place these files in a subdomain. I used `panel.example.com` for that.
32
+
33
+Now open the files `config.cfg.sample`, `.htaccess.sample`, and `.htpasswd.sample` and change all necessary settings. Be sure to remove the `.sample` in the file names of these files afterwards.

Loading…
Cancel
Save