GitHub/trunk-server
1
0
Fork 0
mirror of https://github.com/openmhz/trunk-server.git synced 2026-11-14 01:37:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updating README to detail S3 config.

Browse Source
This commit is contained in:
Nate Carlson
2020-11-26 19:19:13 -06:00
parent 2c991d261f
commit 4d05397cce
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -30,12 +30,18 @@ There are a lot of different components that make up the system. All of the serv
You can run things in 2 different modes, `test` and `prod`. The big difference is that `prod` expects all of the calls to be https and gets cranky when they are not. I have gotten `test` to run fine on my laptop, so that is probably a good starting point. You can run things in 2 different modes, `test` and `prod`. The big difference is that `prod` expects all of the calls to be https and gets cranky when they are not. I have gotten `test` to run fine on my laptop, so that is probably a good starting point.
Currently, both `test` and `prod` expect to use S3-based storage instead of local storage. Switching to use local storage would be relatively easy - but for the sake of testing, let's just say use something S3-compatible. Make sure that ~/.aws/credentials has the credentials you'd like to use with your S3-compatible storage provider.. IE:
```
[default]
aws_access_key_id = [..]
aws_secret_access_key = [..]
```
`./docker-test.sh` - sets up docker-compose to run with the correct environment variables for testing `./docker-test.sh` - sets up docker-compose to run with the correct environment variables for testing
`./docker-prod.sh` - sets up docker-compose to run with the correct environment variables for production `./docker-prod.sh` - sets up docker-compose to run with the correct environment variables for production
Fill out the Environment variables in both these files. You don't need to worry about the Stripe stuff, since that is dormant. Fill out the Environment variables in both these files. S3_PROFILE should match the profile that is defined in the aws/credentials file. You don't need to worry about the Stripe stuff, since that is dormant.
If you are doing frontend work, you can turn off the de-obfuscation. To do this, edit the Dockerfile for the server you are working with. Change the CMD to: If you are doing frontend work, you can turn off the de-obfuscation. To do this, edit the Dockerfile for the server you are working with. Change the CMD to:
`CMD ["npm", "run", "start:dev"]` Just remember to turn it off when you make the code public. `CMD ["npm", "run", "start:dev"]` Just remember to turn it off when you make the code public.
@@ -91,4 +97,4 @@ After doing this, you should have the following domains: api.domain.com, account
### Mailjet ### Mailjet
Sign up for MailJet! Sign up for MailJet!
https://www.mailjet.com https://www.mailjet.com