diff --git a/README.md b/README.md index a190a28..192bd66 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ flask db upgrade ``` Before the application can be run, it will need to be configured. -Run `cp config.yaml.example config.yaml`, and edit it accordingly. Note that at least one could provider must be configured for the application to run. +Run `cp config.yaml.example config.yaml`, then edit `config.yaml` accordingly. Note that at least one cloud provider must be configured for the application to start successfully. To run the application: ``` @@ -43,16 +43,10 @@ flask run --host=0.0.0.0 --port=5000 ``` ### New frontend -To use the new portal frontend: +To build the new portal frontend: -```bash -git clone https://gitlab.com/guardianproject-ops/bypass-censorship/portal-frontend.git frontend -cd frontend -npm install -npm run build - -mkdir -p ../app/static/ui -cp -r dist/* ../app/static/ui +``` +make install-frontend ``` diff --git a/config.yaml.example b/config.yaml.example index c6963fb..efef2c7 100644 --- a/config.yaml.example +++ b/config.yaml.example @@ -15,8 +15,20 @@ SECRET_KEY: iechaj0mun6beih3rooga0mei7eo0iwoal1eeweN SSH_PRIVATE_KEY_PATH: /home/bc/.ssh/id_rsa SSH_PUBLIC_KEY_PATH: /home/bc/.ssh/id_rsa.pub +TERRAFORM_DIRECTORY: /home/bc/portal-terraform TFSTATE_BACKEND: http://127.0.0.1:5000/tfstate + +GLOBAL_NAMESPACE: egbc # will be used as a prefix in the name of all cloud resources + +BYPASS_TOKEN: dummy + +ADMIN_EMAIL: bc@example.com + +SMART_ZONE: example.com + +HIDDEN_AUTOMATIONS: {} + ############################################################################ # Provider configuration follows. You must activate at least one provider. # ############################################################################