diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/API.md (renamed from API.md) | 0 | ||||
| -rw-r--r-- | doc/INSTALL.md (renamed from INSTALL.md) | 9 | ||||
| -rw-r--r-- | doc/LEGACY_INSTALL.md (renamed from INSTALL-OLD.md) | 6 | ||||
| -rw-r--r-- | doc/example.env (renamed from example.env) | 0 | ||||
| -rw-r--r-- | doc/nginx.vhost.production (renamed from nginx.vhost.production) | 0 |
6 files changed, 11 insertions, 12 deletions
@@ -10,7 +10,7 @@ scrubbing](http://sjp.pwn.pl/sjp/;2527372). It is pronounced as *shoorubooru*. - Post content: images (JPG, PNG, GIF, animated GIF), videos (MP4, WEBM), Flash animations - Post comments - Post notes / annotations, including arbitrary polygons -- Rich JSON REST API ([see documentation](https://github.com/rr-/szurubooru/blob/master/API.md)) +- Rich JSON REST API ([see documentation](doc/API.md)) - Token based authentication for clients - Rich search system - Rich privilege system @@ -28,9 +28,9 @@ scrubbing](http://sjp.pwn.pl/sjp/;2527372). It is pronounced as *shoorubooru*. ## Installation It is recommended that you use Docker for deployment. -[See installation instructions.](https://github.com/rr-/szurubooru/blob/master/INSTALL.md) +[See installation instructions.](doc/INSTALL.md) -Users who wish to avoid using Docker may find the [old installation instructions](https://github.com/rr-/szurubooru/blob/master/INSTALL-OLD.md) helpful. +Users who wish to avoid using Docker may find the [old installation instructions](doc/LEGACY_INSTALL.md) helpful. ## Screenshots @@ -44,4 +44,4 @@ Post view: ## License -[GPLv3](https://github.com/rr-/szurubooru/blob/master/LICENSE.md). +[GPLv3](LICENSE.md). diff --git a/INSTALL.md b/doc/INSTALL.md index 72fe4b1..e523a6a 100644 --- a/INSTALL.md +++ b/doc/INSTALL.md @@ -26,12 +26,13 @@ and Docker Compose (version 1.6.0 or greater) already installed. 3. Configure Docker Compose: ```console - user@host:szuru$ cp example.env .env + user@host:szuru$ cp doc/example.env .env user@host:szuru$ edit .env ``` Change the values of the variables in `.env` as needed. - Read the comments to guide you. + Read the comments to guide you. Note that `.env` should be in the root + directory of this repository. ### Running the Application @@ -110,5 +111,5 @@ and Docker Compose (version 1.6.0 or greater) already installed. by having the client docker listen only on localhost by changing `PORT` in your `.env` file to `127.0.0.1:8080` instead of simply `:8080`. Then configure NGINX (or your caching/reverse proxy server of your choice) - to proxy_pass `http://127.0.0.1:8080`. We've included an example config - located in the `nginx-vhost.production` file. + to proxy_pass `http://127.0.0.1:8080`. We've also + [included an example config](./nginx.vhost.production). diff --git a/INSTALL-OLD.md b/doc/LEGACY_INSTALL.md index f34e390..1e667de 100644 --- a/INSTALL-OLD.md +++ b/doc/LEGACY_INSTALL.md @@ -1,7 +1,5 @@ -**This installation guide is deprecated and might be out -of date! It is recommended that you deploy using -[Docker](https://github.com/rr-/szurubooru/blob/master/INSTALL.md) -instead.** +**This installation guide is deprecated and might be out of date! +It is recommended that you deploy using [Docker](INSTALL.md) instead.** This guide assumes Arch Linux. Although exact instructions for other distributions are different, the steps stay roughly the same. diff --git a/example.env b/doc/example.env index 37c9cfa..37c9cfa 100644 --- a/example.env +++ b/doc/example.env diff --git a/nginx.vhost.production b/doc/nginx.vhost.production index 5a95b52..5a95b52 100644 --- a/nginx.vhost.production +++ b/doc/nginx.vhost.production |