services/Distributed-Wiki-New.md
... ...
@@ -35,7 +35,7 @@ You can run `dn42-wiki-go` in three different ways:
35 35
36 36
Pre-built binaries are available in the [GitHub releases](https://github.com/iedon/dn42-wiki-go/releases).
37 37
38
-Please do not forget to clone the repository to copy `config.example.json` and the `template` folder. They should be put together in the same production directory.
38
+Please do not forget to clone the repository to copy `config.example.json`(to `config.json`) and the `template` folder. They should be put together in the same production directory.
39 39
40 40
### Manual Build
41 41
... ...
@@ -50,6 +50,20 @@ Please do not forget to clone the repository to copy `config.example.json` and t
50 50
./build.sh
51 51
```
52 52
53
+Determine which user is used to run `dn42-wiki-go`, then create `~/.gitconfig` for this user, which will be used by `git`.
54
+
55
+For example:
56
+
57
+```ini
58
+[user]
59
+ email = noreply@dn42.jp
60
+ name = IEDON.DN42 Wiki Mirror(116)
61
+```
62
+
63
+Both systemd socket enabler and UNIX domain socket are supported, check example configuration files: `dn42-wiki-go.socket` and `dn42-wiki-go.service`.
64
+
65
+If you would like to use with Docker: `Dockerfile` and `docker-compose.yml` are also provided, bind proper directories and map `config.json` for the App to use, then you are all set.
66
+
53 67
## Webhook Endpoints
54 68
55 69
When `webhook.enabled` = true, the server exposes:
... ...
@@ -97,7 +111,7 @@ All settings are provided through a JSON file. Below is a concise reference of a
97 111
- `git.remote` *(string, default empty)*: Remote URL. Leave empty for standalone/local repositories.
98 112
- `git.localDirectory` *(string, default `./repo`)*: Directory where the wiki repository is cloned or initialised.
99 113
- `git.pullIntervalSec` *(int, default `300`)*: Seconds between background `git pull` operations in live mode. Disabled if no remote is set.
100
-- `git.author` *(string, default `"Anonymous <anonymous@localhost>"`)*: Author string used for commits generated by the application, unless a custom author is provided per request.
114
+- `git.author` *(string, default `"Anonymous <anonymous@localhost>"`)*: Author string used for commits generated by the application.
101 115
- `git.commitMessagePrefix` *(string, default empty)*: Optional prefix prepended verbatim to commit messages supplied by users.
102 116
- `git.commitMessageAppendRemoteAddr` *(string, default empty)*: Optional suffix appended when a request carries a remote address. If the value contains `%s` it is treated as a `fmt` format string; otherwise it is concatenated.
103 117