diff --git a/README.md b/README.md index 2b59152..d355488 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,34 @@ An usable bash-httpserver with easy configuration and PHP. +### *Recomended*: Release installation +1. Download a release from the [Tags](https://gitlab.com/niansa/simpsh-httpd/tags/) +2. Follow step 4 and 5 of "Installation as package" if you selected to download the Prebuild Debian package. Otherwise follow step 3-6 of "Standart installation" ### Installation as package (Debian based distros only) 1. Install build dependencies: `sudo apt install fakeroot` 2. Build package: `cd ; curl https://gitlab.com/niansa/simpsh-httpd/raw/master/mkdeb.sh | bash -` 3. Install package: `sudo dpkg --install ./simpsh-httpd.deb && sudo apt -f install` 4. Edit /etc/simpsh-httpd/config.sh: `sudoedit /etc/simpsh-httpd/config.sh`: - * `FILES` Here is the webroot (homefolder for the website). - * `HTMLTITLE` This is the title for the filelist. + * `FILES` Here is the webroot (homefolder for the website) + * `HTMLTITLE` This is the title for the filelist * `OUTFILE` The finished Document will saved here. ${OUTFILEID} must be included! - * `DEFAULTCONTENTTYPE` This Content-Type send the Server, if the requested File isn't a folder or phpfile. - * `PORT` This port will used for listening. + * `DEFAULTCONTENTTYPE` This Content-Type send the Server, if the requested File isn't a folder or phpfile + * `PORT` This port will used for listening * `WEBSITE` This is the URL of the website (Example: "http://localhost:$PORT") * `ERROR404` This is the error page 404 * `ERROR403` This is the error page 403 5. Start simpsh-httpd: `simpsh-httpd-socat -d` -### Standard installation +### Standart installation 1. Install following packages: `bash socat dos2unix` 2. Download simpsh-httpd: * `$ cd ~` * `$ git clone https://github.com/niansa/simpsh-httpd.git` * `$ cd ./simpsh-httpd` -3. Edit config.sh: - * `FILES` Here is the webroot (homefolder for the website). - * `HTMLTITLE` This is the title for the filelist. - * `OUTFILE` The finished Document will saved here. ${OUTFILEID} must be included! - * `DEFAULTCONTENTTYPE` This Content-Type send the Server, if the requested File isn't a folder or phpfile. - * `PORT` This port will used for listening. - * `WEBSITE` This is the URL of the website (Example: "http://localhost:$PORT") - * `ERROR404` This is the error page 404 - * `ERROR403` This is the error page 403 +3. Edit config.sh with options as shown in "Installation as package" at step 4 4. Make all files executable * `chmod -R a+x ~/simpsh-httpd` 5. Start simpsh-httpd: