smallwat3r/shhh

Deps

Make sure you have make, yarn, and obviously [email protected] installed on your machine.

Postgres

You will need a Postgres server running locally in the background. Create a database named shhh.

CREATE DATABASE shhh;

Flask

You will need to set up a few environment variables. We use them to configure Flask, as well as the application connection to the database.

Rename the file /environments/local.dev.template to /environments/local.dev and fill in the missing variables (these are the variables needed to connect to your local Postgres database).

Once done, from the root of the repository, run:

make local

This command will make sure a virtual environment is created and that all the needed dependencies are installed, and finally launch a flask local server.

You can now access the app at http://localhost:5000

Deps

Make sure you have make, docker and docker-compose installed on your machine.

The application will use the development env variables from /environments/docker.dev.

Docker

From the root of the repository, run

make dc-start  # to start the app (or dc-start-adminer to use adminer)
make dc-stop   # to stop the app

Once the container image has finished building and has started, you can access:

• Shhh at http://localhost:5000
• (and access the database records using Adminer on port 8080 if you launched Shhh with adminer)

Note: When started with the docker-compose set-up, the application is running with Gunicorn.

You can run tests and linting / security reports using the Makefile:

make checks  # run all checks

make tests   # run tests
make pylint  # run Pylint report
make bandit  # run Bandit report
make mypy    # run Mypy report

• FLASK_ENV: the environment config to load (testing, dev-local, dev-docker, heroku, production).
• POSTGRES_HOST: Postgresql hostname
• POSTGRES_USER: Postgresql username
• POSTGRES_PASSWORD: Postgresql password
• POSTGRES_DB: Database name

• SHHH_HOST: This variable can be used to specify a custom hostname to use as the domain URL when Shhh creates a secret (ex: https://<domain-name.com>). If not set, the hostname defaults to request.url_root, which should be fine in most cases.
• SHHH_SECRET_MAX_LENGTH: This variable manages how long the secrets your share with Shhh can be. It defaults to 250 characters.
• SHHH_DB_LIVENESS_RETRY_COUNT: This variable manages the number of tries to reach the database before performing a read or write operation. It could happens that the database is not reachable or is asleep (for instance this happens often on Heroku free plans). The default retry number is 5.
• SHHH_DB_LIVENESS_SLEEP_INTERVAL: This variable manages the interval in seconds between the database liveness retries. The default value is 1 second.