Update README.md

This commit is contained in:
Herbert Reiter
2021-03-06 15:59:42 +01:00
parent 80af757d4d
commit a7a05cc5fa
+14 -11
View File
@@ -2,8 +2,8 @@
## Description ## Description
MoasdaWiki App is an extension of the MoasdaWiki Server to have a copy of MoasdaWiki App is a privacy-friendly frontend for the MoasdaWiki Server
your Wiki content on your mobile device. knowledge management tool. It mirrors the Wiki content on your mobile device.
For MoasdaWiki documentation see https://moasdawiki.net/. For MoasdaWiki documentation see https://moasdawiki.net/.
@@ -13,20 +13,21 @@ For MoasdaWiki documentation see https://moasdawiki.net/.
## Features ## Features
- Synchronizes the data from a MoasdaWiki Server instance. - Synchronizes the content from your MoasdaWiki Server instance.
- Data privacy: No cloud connection established, directly connects to the server inside your private network.
- Fast full text search. - Fast full text search.
- Content cannot be modified within the app as it is no fun to type Wiki syntax on the mobile device, - Calendar integration, shows birthdays and events in the mobile calendar.
changes have to be done via the MoasdaWiki Server. - Data privacy by design: Directly connects to your server instance in your
- Calendar integration, shows birthdays and events in the mobile calendar (German version only). private network. No trackers, never establishes a cloud connection.
- Wiki content cannot be modified within the app as it is no fun to type Wiki
syntax on a mobile device, changes have to be done via the MoasdaWiki Server.
## Synchronize content with a MoasdaWiki Server ## Synchronize content with a MoasdaWiki Server
1. Download MoasdaWiki Server from https://gitlab.com/moasdawiki/moasdawiki-server. 1. Download MoasdaWiki Server from https://gitlab.com/moasdawiki/moasdawiki-server.
1. Set up a MoasdaWiki Server instance in your LAN. 1. Set up a MoasdaWiki Server instance in your LAN.
1. Install and open the MoasdaWiki App. 1. Install the MoasdaWiki App.
1. You can see a hint that the App has to be configured first. Press on that hint. 1. In the app you can see a hint that it has to be configured first. Press on that hint.
1. Press on "Host name" and enter the host name of the server instance, e.g. `192.168.1.101`. Press OK. 1. Press on "Host name" and enter the host name or IP addresse of the server instance, e.g. `192.168.1.101`. Press OK.
1. In the status section below you should see "Needs authorization at server". Otherwise check host name and port again. 1. In the status section below you should see "Needs authorization at server". Otherwise check host name and port again.
1. On server side open the Wiki page in a browser, click on "Help" and "Synchronization". 1. On server side open the Wiki page in a browser, click on "Help" and "Synchronization".
1. You can see a list of devices and synchronization sessions. Check the device name and click on "Grant". 1. You can see a list of devices and synchronization sessions. Check the device name and click on "Grant".
@@ -40,6 +41,8 @@ If you have questions or any problems you can contact me via [support@moasdawiki
## License ## 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 – see the
[LICENSE](https://gitlab.com/moasdawiki/moasdawiki-app/-/blob/master/LICENSE)
file for details.
Copyright (C) Herbert Reiter Copyright (C) Herbert Reiter