mirror of
https://github.com/scinote-eln/scinote-web.git
synced 2025-09-06 05:04:35 +08:00
Add TODO comments to various places within the Wiki
Luka Murn
parent
2fddf051fa
commit
6adfa44f39
10 changed files with 36 additions and 6 deletions
|
|
@ -30,6 +30,8 @@ git clone https://github.com/biosistemika/scinote-web.git
|
|||
|
||||
#### 2. Configure the server
|
||||
|
||||
<!--- TODO: This could be automated in a scope of a single Make command, similarily as for production. -->
|
||||
|
||||
To setup the basic configuration of SciNote server, create a file `config/application.yml` in the root SciNote directory.
|
||||
|
||||
Populate it with mandatory environmental variables, as described in the [environmental variables section](Environmental-variables).
|
||||
|
|
@ -38,6 +40,8 @@ Populate it with mandatory environmental variables, as described in the [environ
|
|||
|
||||
#### 3. Build the local Docker images
|
||||
|
||||
<!--- TODO: We should make a single - or multiple commands - that relate only to setting up everything neccesary, so you don't have to run all these things manually in a hacky way as it's currently done! -->
|
||||
|
||||
In SciNote root folder, run the following command:
|
||||
|
||||
```
|
||||
|
|
@ -68,6 +72,8 @@ Press `Ctrl + C` to shutdown the server.
|
|||
|
||||
#### 4. Initialize the database
|
||||
|
||||
<!--- TODO: This could also be automated by a single command. -->
|
||||
|
||||
To enter the SciNote container, run the following command when inside the SciNote root folder:
|
||||
|
||||
```
|
||||
|
|
@ -87,6 +93,8 @@ This sequence of commands will drop the database, create it, migrate the data sc
|
|||
|
||||
#### 5. Load the front-end dependencies
|
||||
|
||||
<!--- TODO: THIS Could be automated AS WELL! -->
|
||||
|
||||
While still inside the container, run the following 2 commands:
|
||||
|
||||
```
|
||||
|
|
@ -121,6 +129,8 @@ That's it! Open your favourite browser and navigate to [`http://localhost:3000`]
|
|||
|
||||
## Docker containers
|
||||
|
||||
<!--- TODO: This needs to be updated, I'm not sure it's still the case. And the Docker image & container names need to be standardized to support similar naming with prefix/suffix (for e.g. development/production), and possibly also related to the root folder path, so you can run multiple SciNotes in same environment on the same machine. -->
|
||||
|
||||
SciNote server in development mode uses the following Docker containers:
|
||||
|
||||
1. `scinote_development_postgres` **(persistent)** hosts all database engine files, and is placed by default into `/var/lib/docker/volumes` folder on the host system;
|
||||
|
|
|
|||
|
|
@ -1 +1,3 @@
|
|||
<!--- TODO: Revisit this section. -->
|
||||
|
||||
Check out our [Support](https://scinote.net/support/) page for FAQ, as well as different ways of getting in touch with us.
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
<!--- TODO: Revisit this section, probably kick out the Open source Atlassian/Jira references. -->
|
||||
|
||||
We'd love to hear your feedback. *SciNote* was developed with the aim to be a collaborative open-source project, so please open new issues describing any bugs, feature requests or suggestions that you have.
|
||||
|
||||
> **DISCLAIMER: We firmly believe that our vision for the future of SciNote is the right one, therefore we reserve the right to accept OR reject any reported bugs and opened pull requests.**
|
||||
|
|
@ -40,6 +42,8 @@ In order to accept your pull request, we need you to submit a CLA. You only need
|
|||
|
||||
## Code style
|
||||
|
||||
<!--- TODO: This is old now, probably it should go out. -->
|
||||
|
||||
We keep SciNote's codebase consistent by using various code styling conventions. We want to keep this practice in the future, therefore all contributions should follow the below code styling rules provided by various linter configuration files:
|
||||
|
||||
* `Ruby` - [RuboCop](http://batsov.com/rubocop/) - [.rubocop.yml](https://github.com/biosistemika/scinote-web/blob/master/.rubocop.yml).
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@ SciNote reads configuration parameters from system environment parameters. On pr
|
|||
|
||||
Below is an example `application.yml` file, which should get the server running; for full reference, check the dedicated section below to see all available variables.
|
||||
|
||||
<!--- TODO: Maybe the whole below example YAML can go out, if we can generate it using a Makefile command. -->
|
||||
|
||||
```yml
|
||||
# Secrets
|
||||
SECRET_KEY_BASE: "<<secret_key_base>>"
|
||||
|
|
@ -85,7 +87,7 @@ The following section describes all available environmental variables for SciNot
|
|||
| ENABLE_EMAIL_CONFIRMATIONS | No | Whether to require users to confirm the following actions: signing-up, signing-up after being invited, and changing their e-mail. Defaults to `true` on `development` and `production` environments, and to `false` on `test` environment. |
|
||||
| **Initial admin user** | | |
|
||||
| ADMIN_NAME | No | If using seeding (`rails db:seed`), the initial admin user's username. Defaults to `'Admin'`. |
|
||||
| ADMIN_EMAIL | No | If using seeding (`rails db:seed`), the initial admin user's email. Defaults to `'admin@scinote.net'`. |
|
||||
| ADMIN_EMAIL | No | If using seeding (`rails db:seed`), the initial admin user's email. Defaults to `'admin@scinote.net'`. |
|
||||
| ADMIN_PASSWORD | No | If using seeding (`rails db:seed`), the initial admin user's password. Defaults to `'inHisHouseAtRlyehDeadCthulhuWaitsDreaming'`. |
|
||||
| **reCaptcha** | | |
|
||||
| ENABLE_RECAPTCHA | No | Whether to enable [Google reCaptcha](https://www.google.com/recaptcha/) on sign-up and confirm invitation pages. Defaults to `false`. |
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
## How to deploy SciNote onto Heroku
|
||||
|
||||
<!--- TODO: This needs to be revisited, and this could maybe be packaged as a sub-section to Production mode. -->
|
||||
|
||||
Before deploying to Heroku, install heroku client as describe on offical website. To use existing heroku application, add new git remote repository.
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
TODO
|
||||
|
||||
## `make` commands
|
||||
|
||||
<!--- TODO: Make commands are heavily related to the Build & Run section, and need to be updated/added/removed. After that, this section can also be updated. -->
|
||||
|
||||
Call `make` commands to build Docker images and build Rails environment, including database.
|
||||
|
||||
Following commands are available:
|
||||
|
|
@ -13,7 +13,7 @@ Following commands are available:
|
|||
| `make run` | Runs the `db` container & starts the Rails server in `web` container. |
|
||||
| `make start` | Runs the `db` container & starts the Rails server in `web` container in background. |
|
||||
| `make stop` | Stops the `db` & `web` containers. |
|
||||
| `make worker` | Runs the `rails jobs:work` (worker process) in `web` container. |
|
||||
| `make worker` | Runs the `rails jobs:work` (worker process) in `web` container. |
|
||||
| `make cli` | Runs a `/bin/bash` inside the `web` container. |
|
||||
| `make tests` | Execute all Rails tests. |
|
||||
| `make console` | Enters the Rails console in `web` container. |
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
### Table of Contents
|
||||
|
||||
<!--- TODO: Rewrite this section to read more clearly and sequentially. Possibly also related to Make commands overhaul'. -->
|
||||
|
||||
* [Introduction](#user-content-introduction)
|
||||
* [Prerequisites](#user-content-prerequisites)
|
||||
* [Running server in production mode](#user-content-running-server-in-production-mode)
|
||||
|
|
@ -83,7 +85,7 @@ Production SciNote server is using the following containers to operate:
|
|||
* `scinote_jobs_production` hosts the background worker process;
|
||||
* `scinote_web_production` hosts the web application process.
|
||||
|
||||
All persistent volumes will be kept safe in case you delete your Docker containers.
|
||||
All persistent volumes will be kept safe in case you delete your Docker containers.
|
||||
|
||||
> **WARNING!** Running `docker rm` with `-v` flag, however, will also delete these volumes (same thing happens if you run `docker-compose down` with `-v` flag).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
### Delayed jobs
|
||||
|
||||
<!--- TODO: Revisit this section, add/update/remove jobs, and maybe add some introduction, etc. -->
|
||||
|
||||
SciNote uses [delayed jobs](https://github.com/tobi/delayed_job) library to do background processing, mostly for the following tasks:
|
||||
* Sending emails,
|
||||
* Extracting text from uploaded files (*full-text* search),
|
||||
|
|
|
|||
|
|
@ -20,10 +20,14 @@ SciNote server uses `rake`/`rails` tasks for various operations. For details reg
|
|||
|
||||
## Mailer
|
||||
|
||||
<!--- TODO: Just for organization, I'd suggest to move this to a separate page/section. Even if it's small. -->
|
||||
|
||||
SciNote needs a configured SMTP mail server to work properly. See [environmental variables](Environmental-variables) for configuration of the mailer.
|
||||
|
||||
## Office Online integration
|
||||
|
||||
<!--- TODO: I think integrations generally need to be packaged into its own section (e.g. also we're adding Protocols.io integration, and possibly more, into the Core.). -->
|
||||
|
||||
SciNote can be integrated with an Office Online Server to enable viewing and edition of documents directly in the browser. To enable this integration using the Microsoft Office Online servers, you will need to join the [Office Cloud Storage Partner Program](https://dev.office.com/programs/officecloudstorage) and set up the `WOPI_*` environment variables.
|
||||
|
||||
## Heroku
|
||||
|
|
|
|||
|
|
@ -1 +1,3 @@
|
|||
*TODO*
|
||||
*TODO*
|
||||
|
||||
<!--- TODO: This section needs to be revisited. -->
|
||||
Loading…
Add table
Reference in a new issue