scinote-eln/scinote-web
1
1
Fork 0
mirror of https://github.com/scinote-eln/scinote-web.git synced 2025-09-06 05:04:35 +08:00
Code Issues Projects Releases Packages Wiki Activity

Updated Setup guide (markdown)

Luka Murn 2018-06-02 11:00:26 +02:00
parent bce8bdcb0b
commit 3d90a0ff1b
1 changed files with 3 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
Setup-guide.md

@ -1,49 +1,10 @@
## Build & Run
## Build & run
For instructions on how to build & run SciNote - including minimal **quick-start** setup - visit [Build & Run](../Build-&-Run) section.
For instructions on how to build & run SciNote - including minimal **quick-start** setup - visit [Build & run](../Build-&-run) section.
## Environmental variables
SciNote reads configuration parameters from system environment parameters. On production servers, this can simply be system environmental variables, while for development, a file `config/application.yml` can be created to specify those variables.
Below is an example `application.yml` file, which should get the server running; for full reference, check the dedicated page (below) to see all available variables.
```yml
# Secrets
SECRET_KEY_BASE: "<<secret_key_base>>"
PAPERCLIP_HASH_SECRET: "<<paperclip_hash_secret>>"
# File storage
# For local file storage
PAPERCLIP_STORAGE: "filesystem"
# For S3 file storage
#PAPERCLIP_STORAGE: "s3"
#AWS_ACCESS_KEY_ID: ""
#AWS_REGION: ""
#AWS_SECRET_ACCESS_KEY: ""
#S3_BUCKET: ""
#S3_HOST_NAME: ""
# Mailer settings
MAIL_FROM: "Example SciNote Assistant <assistant@yourdomain.com>"
MAIL_REPLYTO: "Example SciNote Assistant <assistant@yourdomain.com>"
SMTP_ADDRESS: "your.yoursmtp.com"
SMTP_PORT: "25"
SMTP_DOMAIN: "yoursmtp.com"
SMTP_USERNAME: "user@yoursmtp.com"
SMTP_PASSWORD: "<<smtp_password>>"
SMTP_AUTH_METHOD: "plain"
MAIL_SERVER_URL: "scinote.yourdomain.com"
# Sign-up process
NEW_TEAM_ON_SIGNUP: "true"
ENABLE_EMAIL_CONFIRMATIONS: "false"
ENABLE_USER_REGISTRATION: "true"
```
For complete list of variables, see [Environmental variables](../Environmental-variables) page.
SciNote is configured using environmental variables. To see list of available variables, and a minimal `application.yml` file, visit [Environmental variables](../Environmental-variables) section.
## Production mode (in Docker containers)