Skip to content

Latest commit

 

History

History
292 lines (204 loc) · 11.6 KB

README.md

File metadata and controls

292 lines (204 loc) · 11.6 KB
Raw

Chewie-NS 🐋 📦 🍪

Documentation Status DOI:10.1093/nar/gkaa889 License: GPL v3

Docker-compose for the Chewie-NS webapp. The main instance of Chewie-NS is available at chewbbaca.online.

Chewie-NS uses the following docker images:

  • postgres: postgres:10
  • virtuoso: openlink/virtuoso-opensource-7:7.2.6-r3-g1b16668
  • redis: redis:5.0.6
  • nginx: nginx:1.17
  • node: node:13
  • NS API: this dockerfile
  • NS UI: this dockerfile

Chewie-NS Documentation

Chewie-NS has all its documentation available at Chewie-NS' Read The Docs.

Local installation

Cookiecutter installation

Chewie-NS has a cookiecutter template that will perform the installation of a local server by automatically modifying some files.

Quickstart

Start by installing the latest cookiecutter version:

pip install cookiecutter

Then, in the directory where you want to create your local server, run:

cookiecutter https://github.com/B-UMMI/Chewie-NS.git

Input variables

Chewie-NS cookiecutter has default input variables defined to create a local installation of Chewie-NS. The values can be changed by the user if necessary. To use the default values, simply press Enter.

The input variables are:

  • directory_name: The name of the directory where the server will be created.
  • flask_app_local_port: Local port for the Flask backend API.
  • flask_email: The email address that sends the reset token to recover a forgotten password.
  • flask_email_password: The password of the email address that will send the reset token.
  • flask_email_default_sender: The email address of the reset token sender.
  • flask_email_server: The server of the email address.
  • flask_email_port: The port of the email server.
  • flask_email_use_tls: Use TLS.
  • flask_email_use_ssl: Use SSL.
  • base_url: The base URL that will be used for the communication between the backend and frontend.
  • postgres_local_port: Local port of the PostgreSQL database.
  • pgadmin_email: PGAdmin email, to log into the PGAdmin interface.
  • pgadmin_password: PGAdmin user password.
  • pgadmin_local_port: Local port of PGAdmin.
  • virtuoso_local_port: Local port of the Virtuoso triple store database.
  • virtuoso_isql_local_port: Local port for Virtuoso's ISQL.
  • redis_local_port: Local port of Redis queuing system.
  • flower_local_port: Local port of Flower, a dashboard to monitor Celery jobs.
  • gunicorn_workers: Number of workers gunicorn will use to deploy the backend of the server.
  • gunicorn_threads: Number of threads gunicorn will use to deploy the backend of the server.
  • local_schema_stats_url: The URL for the Available Schemas page of the local server.
  • local_register_url: The URL for the user registration page of the local server.
  • local_species_url: The URL for a particular species' page.
  • api_url: The URL for the Swagger documentation of the backend API.

After defining the input variables, cookiecutter will create the necessary self-signed certificates for the server to work.

After executing cookiecutter, you can build the local instance of Chewie-NS with the following command:

docker-compose -f docker-compose-production.yaml up --build

Launch the Chewie-NS app by accessing 127.0.0.1 on your browser. This link will take you to the Home page of your local instance of Chewie-NS.

Manual installation

To start a local instance of Chewie-NS, the following files must be modified:

Docker compose configuration file

In this file, the BASE_URL variable needs to be changed to your localhost in the flask_app and the periodic_worker services.

environment:
  - BASE_URL=http://127.0.0.1:5000/NS/api/

The port 80 from the nginx_react service needs to be commented out because only port 443 will be used.

ports:
  # - "80:80"
  - "443:443"

A username and password need to be provided to the pgadmin4 service.

environment:
  PGADMIN_DEFAULT_EMAIL: "[email protected]"
  PGADMIN_DEFAULT_PASSWORD: "testpassword"

NS API Dockerfile

In this Dockerfile, the number of workers and threads provided to the gunicorn command should be adequate to your machines resources. An example command could be:

CMD ["gunicorn", "--worker-tmp-dir", "/dev/shm", "-w", "4", "--threads=2", "--worker-class=gthread", "-b", "0.0.0.0:5000", "wsgi:app"]

NGINX configuration file

The NGINX configuration file has been written to work on a server that uses ports 80 (HTTP) and 443 (HTTPS). On a local instance, we recommend that Chewie-NS only runs on port 443 (HTTPS), so the server block code must be commented out or deleted.

#server {
#    listen 80;
#    server_name chewbbaca.online;
#
#    location ^~ /.well-known {
#      allow all;
#      root  /data/letsencrypt/;
#    }
#
#    location / {
#        return 301 https://chewbbaca.online$request_uri;
#    }
#
#}

The code block that performs the redirection to the server name should also be commented out to avoid redirection to the main instance of Chewie-NS.

# Redirect IP to Server Name
# server {
    
#     listen 443 ssl http2;

#     # SSL certificates
#     #ssl_certificate /etc/nginx/certs/cert.pem;
#     #ssl_certificate_key /etc/nginx/certs/key.pem;

#     # Letsencrypt certficates
#     ssl_certificate /etc/letsencrypt/live/chewbbaca.online/fullchain.pem;
#     ssl_certificate_key /etc/letsencrypt/live/chewbbaca.online/privkey.pem;

#     server_name 194.210.120.209;

#     return 301 $scheme://chewbbaca.online$request_uri;

# }

The server_name on the 443 server block should also be commented out.

#server_name chewbbaca.online;

We also recommend that the certificates be self-signed. Therefore, the block of code related to the path of the self-signed certificates should be uncommented and the Lets Encrypt code block should be deleted.

More information about the creation of the self-signed certificates is below.

# SSL self-signed certificates
ssl_certificate /etc/nginx/certs/cert.pem;
ssl_certificate_key /etc/nginx/certs/key.pem;

# Letsencrypt certficates
# ssl_certificate /etc/letsencrypt/live/chewbbaca.online/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/chewbbaca.online/privkey.pem;

Finally, the last server block that redirects the IP to the domain name should be commented to avoid redirects to the main Chewie-NS website.

Axios configuration file

Axios is a promise-based HTTP client that is used to perform requests to Chewie-NS' API.

The URL of the API on the Axios configuration file needs to be changed to the localhost API in order to perform requests to the local instance of Chewie-NS.

const instance = axios.create({
  baseURL: "http://127.0.0.1:5000/NS/api/",
  headers: { "Content-Type": "application/json" },
});

Frontend Menu Component API URL

The left menu of Chewie-NS' user interface contains a button that redirects the user to the Swagger interface, in order to interact with the API. The URL needs to be changed to the localhost.

<ListItem
    button
    component="a"
    href={"https://127.0.0.1/NS/api/docs"}
    target={"_blank"}
    rel="noopener noreferrer"
>

Homepage description

The homepage description markdown of Chewie-NS has links to the main instance which need to be changed to the localhost.

|[Click here to see the Available Schemas](https://127.0.0.1/stats)|


## Schema submission
If you wish to submit schemas to Chewie-NS you need to register first at the [Register](https://127.0.0.1/register) page.

Creating the self-signed certificates

For starters, create a new directory on the root of the repo named “self_certs”.

mkdir self_certs

Next, run this command to generate the certificate:

openssl req -new -newkey rsa:4096 -days 365 -nodes -x509 -keyout self_certs/key.pem -out self_certs/cert.pem

Finally, run a command to generate the Diffie-Hellman coefficients to improve security:

openssl dhparam -out self_certs/dhparam.pem 4096

In the end, you should have three files inside the “self_certs” directory, key.pem, cert.pem and dhparam.pem.

Starting the compose

To build your local instance of Chewie-NS, run the following command:

docker-compose -f docker-compose-production.yaml up --build

Launch the NS app by accessing 127.0.0.1 on your browser. This link will take you to the Home page of your local instance of Chewie-NS.

The default user's credentials are the following:

username = test@refns.com
password = mega_secret

Notes

Make sure that the necessary ports are not already in use by other services! More info is available here.

Contacts

Citation

If you use Chewie-NS, please cite:

Mamede, R., Vila-Cerqueira, P., Silva, M., Carriço, J. A., & Ramirez, M. (2020). Chewie Nomenclature Server (chewie-NS): a deployable nomenclature server for easy sharing of core and whole genome MLST schemas. Nucleic Acids Research.

Available from: https://academic.oup.com/nar/advance-article/doi/10.1093/nar/gkaa889/5929238