03-running-setup.md

Running setup

There are a number of files and configuration needed to run Grid. The setup.sh script will do all the hard work!

setup.sh will do a number of things:

• Launch the required Docker containers as defined in docker-compose.yml
• Use the CloudFormation templates to create AWS resources within localstack
• Setup NGINX proxies using dev-nginx
• Generate configuration files in ~/.grid
• Optionally create an authentication stack

Running

From the project root, run:

./dev/script/setup.sh

This process will take a little while to complete.

If you see an error message similar to nginx: [emerg] could not build server_names_hash, you should increase server_names_hash_bucket_size, follow these instructions and then run the setup script again. There is more detail on this issue and how it affect running locally in the trouble shooting guide for this project.

Available flags

There are a few options available for setup.sh.

--clean

Adding the --clean flag will result in the Docker containers and any temporary files from previous runs of Grid to be removed before proceeding.

This is useful if you want to be sure there are no remnants of another environment to interfere with your work.

--with-local-auth

Adding the --with-local-auth flag will result in:

• a local authentication stack being created
• the generation of pan-domain-authentication settings and a number of users

Using this flag is encouraged if you're outside the Guardian and want to run Grid locally without setting up pan-domain-authentication for real.

--no-auth

Adding this flag will result in effectively no auth, you'll be signed in automatically as John Doe (with no oauth flow) and will have ALL permissions.