]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - doc/md/Server-configuration.md
doc: server configuration: add reminder to change the example domain name
[github/shaarli/Shaarli.git] / doc / md / Server-configuration.md
index 73e23886909cbbfdd45de4172f5bb7644036e7ba..bb488ef0b2e5f678a884fba2baed24a330e1a87c 100644 (file)
@@ -1,7 +1,5 @@
 # Server configuration
 
-
-
 ## Requirements
 
 ### Operating system and web server
@@ -25,6 +23,14 @@ Setup a **firewall** (using `iptables`, [ufw](https://www.digitalocean.com/commu
 Shaarli makes outbound HTTP/HTTPS connections to websites you bookmark to fetch page information (title, thumbnails), the server must then have access to the Internet as well, and a working DNS resolver.
 
 
+### Screencast
+
+Here is a screencast of the installation procedure
+
+[![asciicast](https://asciinema.org/a/z3RXxcJIRgWk0jM2ws6EnUFgO.svg)](https://asciinema.org/a/z3RXxcJIRgWk0jM2ws6EnUFgO)
+
+--------------------------------------------------------------------------------
+
 ### PHP
 
 Supported PHP versions:
@@ -105,7 +111,7 @@ If you don't want to rely on a certificate authority, or the server can only be
 The following examples assume a Debian-based operating system is installed. On other distributions you may have to adapt details such as package installation procedures, configuration file locations, and webserver username/group (`www-data` or `httpd` are common values). In these examples we assume the document root for your web server/virtualhost is at `/var/www/shaarli.mydomain.org/`:
 
 ```bash
-# create the document root
+# create the document root (replace with your own domain name)
 sudo mkdir -p /var/www/shaarli.mydomain.org/
 ```
 
@@ -119,7 +125,7 @@ You can install Shaarli at the root of your virtualhost, or in a subdirectory as
 sudo apt update
 sudo apt install apache2 libapache2-mod-php php-json php-mbstring php-gd php-intl php-curl php-gettext
 
-# Edit the virtualhost configuration file with your favorite editor
+# Edit the virtualhost configuration file with your favorite editor (replace the example domain name)
 sudo nano /etc/apache2/sites-available/shaarli.mydomain.org.conf
 ```
 
@@ -402,6 +408,8 @@ maxretry = 3
 bantime = -1
 ```
 
+Then restart the service: `sudo systemctl restart fail2ban`
+
 #### References
 
 - [Apache/PHP - error log per VirtualHost - StackOverflow](http://stackoverflow.com/q/176)