README.md 4.38 KB
Newer Older
Herbert Reiter's avatar
Herbert Reiter committed
1 2
# MoasdaWiki Server

Herbert Reiter's avatar
Herbert Reiter committed
3 4
## Description

Herbert Reiter's avatar
Herbert Reiter committed
5 6 7
MoasdaWiki Server is a privacy-friendly and interactive knowledge management
tool. It provides a browser-based GUI to search, create, and modify content in
Wiki style.
Herbert Reiter's avatar
Herbert Reiter committed
8

Herbert Reiter's avatar
Herbert Reiter committed
9
For documentation see https://moasdawiki.net/.
Herbert Reiter's avatar
Herbert Reiter committed
10

Herbert Reiter's avatar
Herbert Reiter committed
11 12 13
### Key features

- Easy usability
Herbert Reiter's avatar
Herbert Reiter committed
14
- No installation required, can be unzipped and run on a USB stick
Herbert Reiter's avatar
Herbert Reiter committed
15 16
- No special system requirements like database or application server
- Runs on any system with a Java VM 1.8 or higher
Herbert Reiter's avatar
Herbert Reiter committed
17 18 19 20
- [MoasdaWiki App](https://gitlab.com/moasdawiki/moasdawiki-app) available,
  always have a copy of the Wiki content on your mobile device
- Data privacy by design: Stores content only on the local computer, never
  establishes a cloud connection
Herbert Reiter's avatar
Herbert Reiter committed
21
- Free/Libre and Open Source Software (FLOSS)
Herbert Reiter's avatar
Herbert Reiter committed
22 23 24

### Feature list

Herbert Reiter's avatar
Herbert Reiter committed
25 26
- Powerful syntax, supports tables and images
- Fast full-text search
Herbert Reiter's avatar
Herbert Reiter committed
27 28 29 30 31 32
- Page templates to create uniform looking pages
- Full customizable graphical user interface
  - Navigation panel can be modified
  - Page layout for view in browser and for printing is defined by CSS stylesheet
  - Page header and footer can be modified
  - Customizable HTML header, e.g. to include your own CSS stylesheets and JavaScript libraries
Herbert Reiter's avatar
Herbert Reiter committed
33
  - Configuration file with several options
Herbert Reiter's avatar
Herbert Reiter committed
34 35
- Internationalization via message files
- List of recently modified and viewed pages
Herbert Reiter's avatar
Herbert Reiter committed
36 37 38
- Built-in lightweight web server, no external web server required
- Stores pages as text files in a folder in the local file system;
  for backups just make a copy of that folder.
Herbert Reiter's avatar
Herbert Reiter committed
39

Herbert Reiter's avatar
Herbert Reiter committed
40
## Download / Build
Herbert Reiter's avatar
Herbert Reiter committed
41

Herbert Reiter's avatar
Herbert Reiter committed
42 43
**Download** MoasdaWiki server from the
[releases page](https://gitlab.com/moasdawiki/moasdawiki-server/-/releases).
Herbert Reiter's avatar
Herbert Reiter committed
44
Unzip the file `moasdawiki-server-x.y.z.zip` in any folder.
45 46
No special installation steps necessary.

Herbert Reiter's avatar
Herbert Reiter committed
47
Alternatively, you can clone the GitLab repository and **build** the project locally:
Herbert Reiter's avatar
Herbert Reiter committed
48

49 50 51
```
gradle build
```
Herbert Reiter's avatar
Herbert Reiter committed
52

53
Afterwards, you will find the target ZIP file in the folder ```build/distributions/```.
Herbert Reiter's avatar
Herbert Reiter committed
54

Herbert Reiter's avatar
Herbert Reiter committed
55
## Run from Terminal (Linux/Windows)
Herbert Reiter's avatar
Herbert Reiter committed
56

Herbert Reiter's avatar
Herbert Reiter committed
57 58
MoasdaWiki server requires Java 1.8 or higher and is running on several
operating systems and platforms.
Herbert Reiter's avatar
Herbert Reiter committed
59

Herbert Reiter's avatar
Herbert Reiter committed
60
1. Open a Terminal
Herbert Reiter's avatar
Herbert Reiter committed
61 62
2. Go to folder that contains `moasdawiki-server-x.y.z.jar`
3. `java -jar moasdawiki-server-x.y.z.jar repository-en`
Herbert Reiter's avatar
Herbert Reiter committed
63

Herbert Reiter's avatar
Herbert Reiter committed
64 65
After starting the Wiki server it can be accessed by any web browser, open the URL:
http://localhost:11080/
Herbert Reiter's avatar
Herbert Reiter committed
66

Herbert Reiter's avatar
Herbert Reiter committed
67 68 69
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`.
Herbert Reiter's avatar
Herbert Reiter committed
70

Herbert Reiter's avatar
Herbert Reiter committed
71 72
## Run as a Linux daemon
### Using systemd (since Ubuntu 15.10)
Herbert Reiter's avatar
Herbert Reiter committed
73 74 75

1. Check if systemd is running
   ```
Herbert Reiter's avatar
Herbert Reiter committed
76 77
   $ cat /proc/1/comm
   systemd
Herbert Reiter's avatar
Herbert Reiter committed
78
   ```
Herbert Reiter's avatar
Herbert Reiter committed
79

Herbert Reiter's avatar
Herbert Reiter committed
80 81
2. Install required packages
   - `openjdk-8-jre` (any Java VM 1.8 or higher)
Herbert Reiter's avatar
Herbert Reiter committed
82
   - `jsvc` (see https://commons.apache.org/proper/commons-daemon/)
Herbert Reiter's avatar
Herbert Reiter committed
83
   - `libcommons-daemon-java`
Herbert Reiter's avatar
Herbert Reiter committed
84 85 86 87

3. Edit the files `moasdawiki.sh` and `moasdawiki.service` and adjust the paths.

4. Mark the files as executable
Herbert Reiter's avatar
Herbert Reiter committed
88 89 90 91
   ```
   chmod a+x moasdawiki.service
   chmod a+x moasdawiki.sh
   ```
Herbert Reiter's avatar
Herbert Reiter committed
92 93

5. Create a systemd service
Herbert Reiter's avatar
Herbert Reiter committed
94 95 96
   ```
   sudo cp /path/to/moasdawiki.service /etc/systemd/system
   ```
Herbert Reiter's avatar
Herbert Reiter committed
97 98

6. Activate und start the systemd service
Herbert Reiter's avatar
Herbert Reiter committed
99 100 101 102 103
   ```
   sudo systemctl enable moasdawiki.service
   sudo systemctl start moasdawiki.service
   ```

Herbert Reiter's avatar
Herbert Reiter committed
104
### Using SysVinit
Herbert Reiter's avatar
Herbert Reiter committed
105 106 107

1. Install required packages
   - `openjdk-8-jre` (any Java VM 1.8 or higher)
Herbert Reiter's avatar
Herbert Reiter committed
108
   - `jsvc` (see https://commons.apache.org/proper/commons-daemon/)
Herbert Reiter's avatar
Herbert Reiter committed
109
   - `libcommons-daemon-java`
Herbert Reiter's avatar
Herbert Reiter committed
110 111 112

2. Edit the file `moasdawiki.sh` and adjust the paths.

Herbert Reiter's avatar
Herbert Reiter committed
113 114 115 116
3. Mark the file as executable
   ```
   chmod a+x moasdawiki.sh
   ```
Herbert Reiter's avatar
Herbert Reiter committed
117 118

4. Create a symbolic link in `/etc/init.d`
Herbert Reiter's avatar
Herbert Reiter committed
119 120 121
   ```
   sudo ln -s /path/to/moasdawiki.sh /etc/init.d/moasdawiki
   ```
Herbert Reiter's avatar
Herbert Reiter committed
122 123

5. Create symbolic links for daemon start up and daemon shut down in runlevel 2:
Herbert Reiter's avatar
Herbert Reiter committed
124 125 126 127 128 129
   ```
   cd /etc/rc2.d
   sudo ln -s ../init.d/moasdawiki S95moasdawiki
   sudo ln -s ../init.d/moasdawiki K05moasdawiki
   ```

Herbert Reiter's avatar
Herbert Reiter committed
130
## User guide
Herbert Reiter's avatar
Herbert Reiter committed
131

Herbert Reiter's avatar
Herbert Reiter committed
132 133
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
Herbert Reiter's avatar
Herbert Reiter committed
134
http://localhost:11080/view/wiki/
Herbert Reiter's avatar
Herbert Reiter committed
135 136 137 138 139 140 141

## Support

If you have questions or any problems you can contact me via [support@moasdawiki.net]().

## License

Herbert Reiter's avatar
Herbert Reiter committed
142 143 144
MoasdaWiki server is licensed under the GPL 3 license – see the
[LICENSE](https://gitlab.com/moasdawiki/moasdawiki-server/-/blob/master/LICENSE)
file for details.
Herbert Reiter's avatar
Herbert Reiter committed
145 146

Copyright (C) Herbert Reiter