diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 7 insertions, 11 deletions
@@ -22,16 +22,17 @@ $ gitpad Listening on http://127.0.0.1:8000 ``` -Files are served under `/~{branch}/{path}`, so for example `/~hello/world.md` -refers to the `world.md` file in the `hello` branch. By default GitPad is in -single-user mode, letting the user view and edit all branches (as well as create -new branches). +By default GitPad is in single-user mode, serving the branch pointed to by `HEAD`. ## Multi-user mode Multi-user mode requires you to set up a reverse-proxy that authenticates users -and sets the `Username` header. The simplest authentication mechanism is HTTP -Basic Auth. With NGINX a reverse-proxy could be configured as follows: +and sets the `Username` header. Every user gets their own private Git branch, +named exactly like their username and served under `/~{username}`. Users can +share files/directories with other users by creating a `.shares.txt` file. + +The simplest authentication mechanism is HTTP Basic Auth. With NGINX a +reverse-proxy could be configured as follows: ```nginx server { @@ -60,11 +61,6 @@ refer to the [NGINX documentation](https://docs.nginx.com/nginx/admin-guide/secu Once you have set this up start GitPad in multi-user mode by running it with the `-m` flag. -In multi-user mode every user has their own Git branch, named exactly like their -username. Your own branch is private by default, other users cannot access your -files. Users can however share files/directories with other users by creating a -`.shares.txt` file. - ## Configuring committer identities In single-user mode GitPad just uses the |