Update README.md

README.md

@@ -13,8 +13,8 @@ For documentation see https://moasdawiki.net/.
 - No setup necessary, can be run from a USB stick
 - No special system requirements like database or application server
 - Runs on any system with a Java VM 1.8 or higher
-- App available, always have a copy of the Wiki content on your mobile device, see https://gitlab.com/moasdawiki/moasdawiki-app.
-- Free of charge, open source
+- [MoasdaWiki App](https://gitlab.com/moasdawiki/moasdawiki-app) available, always have a copy of the Wiki content on your mobile device
+- Free/Libre and Open Source Software (FLOSS)
 
 ### Feature list
 
@@ -32,108 +32,98 @@ For documentation see https://moasdawiki.net/.
 - Internationalization via message files
 - List of recently modified and viewed pages
 
-## Installation
-### Prerequisites
+## Download / Build
 
-MoasdaWiki server requires Java 1.8 or higher and is running on several
-operating systems and platforms.
-
-### Download / Build
-
-You can **download** MoasdaWiki server from https://gitlab.com/moasdawiki/moasdawiki-server/-/tags.
-Unzip the file `moasdawiki-server-<version>.zip` in any folder.
+**Download** MoasdaWiki server from the
+[releases page](https://gitlab.com/moasdawiki/moasdawiki-server/-/releases).
+Unzip the file `moasdawiki-server-2.x.y.zip` in any folder.
 No special installation steps necessary.
 
-Alternatively, you can clone and **build** the project locally:
+Alternatively, you can clone the GitLab repository and **build** the project locally:
 ```
 gradle build
 ```
 Afterwards, you will find the target ZIP file in the folder ```build/distributions/```.
 
-### Running manually
-
-Ways to start the Wiki server:
-
-#### Via console (Linux/Windows)
-
-1. Open a console
-2. Go to folder that contains `moasdawiki-server-<version>.jar`
-3. `java -jar moasdawiki-server-<version>.jar repository-en`
+## Run from Terminal (Linux/Windows)
 
-#### Via shortcut icon (Windows)
+MoasdaWiki server requires Java 1.8 or higher and is running on several
+operating systems and platforms.
 
-1. Create a new shortcut (right mouse button on desktop &rarr; New &rarr; Shortcut)
-2. Location: `javaw.exe -jar moasdawiki-server-<version>.jar repository-en`
-3. Run in: Folder that contains `moasdawiki-server-<version>.jar repository-en`
-4. Double click on the shortcut
+1. Open a Terminal
+2. Go to folder that contains `moasdawiki-server-2.x.y.jar`
+3. `java -jar moasdawiki-server-2.x.y.jar repository-en`
 
-MoasdaWiki expects the repository with the Wiki pages in the sub folder `repository-en`.
-To choose the repository with German language use `repository-de` instead.
+After starting the Wiki server it can be accessed by any web browser, open the URL:
+http://localhost:11080/
 
-### Running as a Linux daemon
+If the Wiki server runs on a different host, use the host name or its IP address
+instead of `localhost`. The default port is 11080. It can be changed in the file
+`repository/config.txt`.
 
-#### Using systemd (since Ubuntu 15.10)
+## Run as a Linux daemon
+### Using systemd (since Ubuntu 15.10)
 
 1. Check if systemd is running
    ```
-   cat /proc/1/comm
-   # must return "systemd"
+   $ cat /proc/1/comm
+   systemd
    ```
+
 2. Install required packages
    - `openjdk-8-jre` (any Java VM 1.8 or higher)
-   - `jsvc` (see http://jakarta.apache.org/commons/daemon/)
+   - `jsvc` (see https://commons.apache.org/proper/commons-daemon/)
    - `libcommons-daemon-java`
-3. Open files `moasdawiki.sh` and `moasdawiki.service` with a text editor and adjust the paths.
-4. Mark files as executable
+
+3. Edit the files `moasdawiki.sh` and `moasdawiki.service` and adjust the paths.
+
+4. Mark the files as executable
    ```
    chmod a+x moasdawiki.service
    chmod a+x moasdawiki.sh
    ```
-5. Create systemd service
+
+5. Create a systemd service
    ```
    sudo cp /path/to/moasdawiki.service /etc/systemd/system
    ```
-6. Activate und start systemd service
+
+6. Activate und start the systemd service
    ```
    sudo systemctl enable moasdawiki.service
    sudo systemctl start moasdawiki.service
    ```
 
-#### Using SysVinit
+### Using SysVinit
 
 1. Install required packages
    - `openjdk-8-jre` (any Java VM 1.8 or higher)
-   - `jsvc` (see http://jakarta.apache.org/commons/daemon/)
+   - `jsvc` (see https://commons.apache.org/proper/commons-daemon/)
    - `libcommons-daemon-java`
-2. Open the file `moasdawiki.sh` with a text editor and adjust the paths.
+
+2. Edit the file `moasdawiki.sh` and adjust the paths.
+
 3. Mark the file as executable
    ```
    chmod a+x moasdawiki.sh
    ```
-4. Create symbolic link in `/etc/init.d`
+
+4. Create a symbolic link in `/etc/init.d`
    ```
    sudo ln -s /path/to/moasdawiki.sh /etc/init.d/moasdawiki
    ```
-5. Create symbolic links for daemon start up and shut down in runlevel 2:
+
+5. Create symbolic links for daemon start up and daemon shut down in runlevel 2:
    ```
    cd /etc/rc2.d
    sudo ln -s ../init.d/moasdawiki S95moasdawiki
    sudo ln -s ../init.d/moasdawiki K05moasdawiki
    ```
 
-## Usage
-### Browser URL
-
-After starting the Wiki server it can be accessed by any web browser opening the URL:
-http://localhost:11080/
-
-If the Wiki server runs on a different host, use the host name or its IP address
-instead of `localhost`. The default port is 11080. It can be changed in the file `config.txt`.
-
-### User guide
+## User guide
 
-A detailed description of MoasdaWiki server is included in the default Wiki repository.
-To open the user guide click on the link "Help" in the navigation panel or open the URL
+A detailed description of the MoasdaWiki server is bundled in the downloaded ZIP file.
+To open the user guide click on the "Help" link in the navigation panel or open the URL
 http://localhost:11080/view/wiki/
 
 ## Support
@@ -142,6 +132,8 @@ If you have questions or any problems you can contact me via [support@moasdawiki
 
 ## License
 
-MoasdaWiki server is licensed under the GPL 3 license - see the LICENSE file for details.
+MoasdaWiki server is licensed under the GPL 3 license &ndash; see the
+[LICENSE](https://gitlab.com/moasdawiki/moasdawiki-server/-/blob/master/LICENSE)
+file for details.
 
 Copyright (C) Herbert Reiter

src/main/dist/moasdawiki.sh

@@ -3,16 +3,17 @@
 #  MoasdaWiki Server
 #
 #  Script to run MoasdaWiki server as Linux daemon.
-#  See README for installation tutorial. 
+#  See README.md for installation tutorial.
 #
 
-JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre        # binary folder of JRE
-JSVC_HOME=/usr/bin                                     # binary folder of jsvc
-COMMONS_DAEMON_JAR=/usr/share/java/commons-daemon.jar  # path to commons-daemon.jar
-MOASDAWIKI_HOME=/home/username/moasdawiki              # folder containing MoasdaWiki.jar
-MOASDAWIKI_REPOSITORY=$MOASDAWIKI_HOME/repository-en   # repository folder, change language on demand
-MOASDAWIKI_USER=username
-CLASSPATH=$COMMONS_DAEMON_JAR:$MOASDAWIKI_HOME/MoasdaWiki-version.jar  # JAR file to run, replace version string
+MOASDAWIKI_USER=youruser
+MOASDAWIKI_HOME=/home/$MOASDAWIKI_USER/moasdawiki            # folder containing MoasdaWiki.jar
+MOASDAWIKI_REPOSITORY=$MOASDAWIKI_HOME/repository-en         # repository folder, change language on demand
+MOASDAWIKI_JAR=$MOASDAWIKI_HOME/moasdawiki-server-2.x.y.jar  # JAR file name, replace version string
+JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre              # binary folder of JRE
+JSVC_HOME=/usr/bin                                           # binary folder of jsvc
+COMMONS_DAEMON_JAR=/usr/share/java/commons-daemon.jar        # path to commons-daemon.jar
+CLASSPATH=$COMMONS_DAEMON_JAR:$MOASDAWIKI_JAR
 PID_FILE=/var/run/moasdawiki.pid
 
 export LANG=de_DE.UTF-8