From 360ae96013c89c2a65432961bac4b24399a9e07d Mon Sep 17 00:00:00 2001 From: Simon Beginn Date: Sat, 28 Nov 2020 22:04:27 +0100 Subject: [PATCH] Major cleanup + reformatting --- README.md | 2 +- docs/{ => apache}/000-default-le-ssl.conf | 0 docs/{installapache.md => apache/install.md} | 53 +++++++++++++------- 3 files changed, 36 insertions(+), 19 deletions(-) rename docs/{ => apache}/000-default-le-ssl.conf (100%) rename docs/{installapache.md => apache/install.md} (56%) diff --git a/README.md b/README.md index 1ae916f..e14eb40 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Make sure to support the developers by buying the choosen subscription for your This is _optional_. You can simply use the default instance of this API (host is noted inside the `setup.sh` script) and profit from "automatic" updates. Just transfer the `www` files inside a public accessible root-folder on your _seperate_ Apache (really everthing with PHP support works) webserver. Also make sure your instance has a valid SSL-certificate (Let's encrypt is enough), otherwise it may won't work. -A example Apache install process can be found [here](docs/apacheinstall.md). When you want to test your instance, just open the public accessible url in your browser and append `/notification` to it - when you see some JSON with the text, everthing worked! +A example Apache install process can be found [here](docs/apache/install.md). When you want to test your instance, just open the public accessible url in your browser and append `/notification` to it - when you see some JSON with the text, everthing worked! ### Nett2Know ### * This modification will also block any communication to the Pritunl servers - so no calling home :) diff --git a/docs/000-default-le-ssl.conf b/docs/apache/000-default-le-ssl.conf similarity index 100% rename from docs/000-default-le-ssl.conf rename to docs/apache/000-default-le-ssl.conf diff --git a/docs/installapache.md b/docs/apache/install.md similarity index 56% rename from docs/installapache.md rename to docs/apache/install.md index cfe8dc5..5d27637 100644 --- a/docs/installapache.md +++ b/docs/apache/install.md @@ -1,16 +1,26 @@ +# HowTo install the selfhost on Apache + First you want to install the apache2. -`sudo apt-get install apache2` +```bash +sudo apt-get install apache2 +``` After install all of the relevent apache modules: -`sudo apt-get -y install php7.4-mysql php7.4-curl php7.4-gd php7.4-intl php-pear php-imagick php7.4-imap php-memcache` +```bash +sudo apt-get -y install php7.4-mysql php7.4-curl php7.4-gd php7.4-intl php-pear php-imagick php7.4-imap php-memcache +``` Then install certbot for free ssl certs : -`sudo apt-get install -y certbot` -After this then create a basic site config for the fake api server, do this by creating a file under /etc/apache2/sites-enabled/000-default-le-ssl.conf with the example conf ![example]docs/000-default-le-ssl.conf +```bash +sudo apt-get install -y certbot +``` +After this then create a basic site config for the fake api server, do this by creating a file under /etc/apache2/sites-enabled/000-default-le-ssl.conf with the example conf [example](docs/apache/000-default-le-ssl.conf). Then generate a ssl certificate for the website with certbot. -sudo certbot -d [mypublicallyaccessibledomain] -Once this is done you should check if you have all of the required loaded php modules required for this server. You can check this by running `sudo apache2ctl -M` -and the output should look be something like -`sudo apache2ctl -M +```bash +sudo certbot -d [PUBLIC_ACCESSIBLE_API_DOMAIN] +``` +Once this is done you should check if you have all of the required loaded php modules required for this server. You can check this by running `sudo apache2ctl -M` and the output should look be something like +``` +sudo apache2ctl -M Loaded Modules: core_module (static) so_module (static) @@ -45,15 +55,22 @@ Loaded Modules: setenvif_module (shared) socache_shmcb_module (shared) ssl_module (shared) - status_module (shared)` + status_module (shared) +``` -then clone this repo if you've not done this already and cd into the root of the project -`git clone https://gitlab.simonmicro.de/simonmicro/pritunl-fake-api.git` -`cd ./pritunl-fake-api` - After this is done copy over the API server docs to the server and set permissions - `sudo cp -R ./www/* /var/html/` -` sudo chown www-data:www-data -R /var/www/html` -`sudo chmod -R 774 /var/www/html/ +Then clone this repo if you've not done this already and `cd` into the root of the project: +```bash +git clone https://gitlab.simonmicro.de/simonmicro/pritunl-fake-api.git +cd ./pritunl-fake-api +``` +After this is done copy over the API server files to the server and set permissions +```bash +sudo cp -R ./www/* /var/html/ +sudo chown www-data:www-data -R /var/www/html +sudo chmod -R 774 /var/www/html/ +``` Then restart apache2 to make sure all of the configuration is loaded -`sudo systemctl restart apache2` -Once this is done you should get a response when you visit https://[mydomain]/notification \ No newline at end of file +```bash +sudo systemctl restart apache2 +``` +Once this is done you should get a response when you visit `https://[PUBLIC_ACCESSIBLE_API_DOMAIN]/notification`!