diff --git a/Setup-guide.md b/Setup-guide.md index 1ce0c3f..a1ce22b 100644 --- a/Setup-guide.md +++ b/Setup-guide.md @@ -20,7 +20,7 @@ The following are minimal steps needed to start SciNote in development environme 5. Exit the Docker container by typing `exit`. 6. To start the server, run command `make run`. Wait until the server starts listening on port `3000`. 7. Inside another CLI window (also from SciNote folder), run command `make worker`. This command should start the background worker process which is used by SciNote for a lot of demanding tasks. -8. Open your favourite browser and navigate to [http://localhost:3000](http://localhost:3000/). Use the seeded administrator account from [seeds.rb](https://github.com/biosistemika/scinote-web/blob/master/db/seeds.rb) (or account set up using [environmental variables](../Environmental-variables)) to login, or sign up for a new account. +8. Open your favourite browser and navigate to [`http://localhost:3000`](http://localhost:3000/). Use the seeded administrator account from [seeds.rb](https://github.com/biosistemika/scinote-web/blob/master/db/seeds.rb) (or account set up using [environmental variables](../Environmental-variables)) to login, or sign up for a new account. If you need to run server in production please check [this section](#running-inside-docker-containers-in-production-mode-with-docker-compose). @@ -62,7 +62,7 @@ On Windows 10, you can use [Docker for Windows](https://docs.docker.com/docker-f When starting SciNote application in development mode it runs in a Docker container called `scinote_web_development`, which uses volume `scinote_development_files` for storing uploaded files and `scinote_development_bundler` for storing program dependencies. The database runs in a separate container, called `scinote_db_development`. This database container makes use of a persistent volume called `scinote_development_postgres` for storing database files. **For versions prior to 1.10.0** -The main SciNote application runs in a Docker container called web. The database runs in a separate container, called db. This database container makes use of a special, persistent container called dbdata. +The main SciNote application runs in a Docker container called `web`. The database runs in a separate container, called `db`. This database container makes use of a special, persistent container called `dbdata`. For running application in production please check this [section](#running-inside-docker-containers-in-production-mode-with-docker-compose) @@ -137,7 +137,7 @@ New functionality for running in production mode was introduced with SciNote ver * docker engine (version 1.12.0+), * docker-compose (version 1.6.0+). -You'll also need to set environment variables in `production.env` file; variables are the same as described in [Environmental variables section](#user-content-environmental-variables), the only differences are: +You'll also need to set environment variables in `production.env` file; variables are the same as described in [Environmental variables section](../Environmental-variables), the only differences are: * format of records is changed - use `KEY=VALUE` record format; * you should set `DATABASE_URL=postgresql://postgres@db/scinote_production` without quotation marks. @@ -253,7 +253,7 @@ To generate a new system notification that will be sent to all SciNote users, ex ## Mailer -SciNote needs a configured SMTP mail server to work properly. See [environmental variables](#user-content-environmental-variables) for configuration of the mailer. +SciNote needs a configured SMTP mail server to work properly. See [environmental variables](../Environmental-variables) for configuration of the mailer. ## Office Online integration