updated readme

This commit is contained in:
tavo-wasd 2023-11-17 21:28:16 -06:00
parent 6887ef6f79
commit a97e36cd52

View file

@ -6,10 +6,11 @@ Minimal groff web frontend
## Try it out
Dependencies: `groff-base grap php-fpm`.
Run the following command and visit http://0.0.0.0:8000 in your browser. (It will create a tmp directory!)
Run the following and visit http://0.0.0.0:8000 in your browser. (It will create a tmp directory!)
```shell
wget -qO - "https://gitlab.com/tavo-wasd/groff-web/-/raw/main/public/index.php" | php -S 0.0.0.0:8000
wget "https://gitlab.com/tavo-wasd/groff-web/-/raw/main/public/index.php"
php -S 0.0.0.0:8000
```
## Installation
@ -32,12 +33,21 @@ chown -R www-data:www-data /var/www/groff-web
nginx setup.
```shell
wget -O /etc/nginx/sites-available/groff-web "https://gitlab.com/tavo-wasd/groff-web/-/raw/main/nginx.conf"
wget -O /etc/nginx/sites-available/groff-web.conf "https://gitlab.com/tavo-wasd/groff-web/-/raw/main/nginx.conf"
sed -i 's/groff.example.org/MY.DOMAIN.COM/' /etc/nginx/sites-available/groff-web.conf
ln -s /etc/nginx/sites-available/groff-web.conf /etc/nginx/sites-enabled/
systemctl reload nginx
```
## Remove
```shell
rm -r /var/www/groff-web
rm /etc/nginx/sites-available/groff-web.conf
rm /etc/nginx/sites-enabled/groff-web.conf
systemctl reload nginx
```
## Configuration
Go to `/var/www/groff-web/index.php`, here you can: