diff --git a/README.md b/README.md index 29eceddb..d2d8fba8 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,14 @@ The Zoo also provides analytics about how dependency usage and its versions evol ## Development +### Initial setup + +- Create a database: `$ make migrate` +- Create a superuser: `$ make superuser` +- Create `.env` file as documented below + +### How to run + - Run in debug mode: `$ make run` - Stop: `$ make stop` - Stop and/or delete data: `$ make destroy` @@ -41,11 +49,6 @@ Access web locally: - Login at with your superuser account - Access zoo at -### Initial setup - -- Create a database: `$ make migrate` -- Create a superuser: `$ make superuser` - ### Database changes - Generate database migrations: `$ make makemigrations` @@ -56,6 +59,21 @@ Access web locally: Check `Makefile` for shell commands if you want to run them with modified parameters. +### Local .env file + +Creating a local `.env` file (see [Docker docs](https://docs.docker.com/compose/env-file/) +on `.env` files) is necessary for some components in the app to work correctly, +a basic example of such file contains the following: + +``` +ZOO_DEBUG=1 +ZOO_GITHUB_TOKEN=... +ZOO_GITLAB_TOKEN=... +ZOO_GITLAB_URL=https://gitlab.com +``` + +Version control tokens only need read access to repositories. + ## Testing Run all tests: `$ make test` @@ -99,4 +117,4 @@ Setup virtual enviroment and install there `docs-requirements.txt`. Then you can use shortcuts: - Build docs: `$ make build-docs` -- Open docs: `$ make read-docs` +- Open docs: `$ make open-docs` diff --git a/docs/index.rst b/docs/index.rst index ebe42f9c..4b3a6444 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -55,13 +55,13 @@ Then you describe the errors with the following parameters: namespace: py_security category: Security Issues in Python Code --- - - id: user_input_improperly_handeled + - id: user_input_improperly_handled severity: critical effort: medium title: Handle user input correctly description: | Applications with improperly handled user input become vulnerable to attacks like - command injection, SSRF, SQL injection, XSS, directory traveral etc. + command injection, SSRF, SQL injection, XSS, directory traversal etc. [PyT](https://github.com/python-security/pyt) reported security vulnerabilities in the following files: