diff --git a/README.md b/README.md index 9f9cc0b..6dc5c50 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,18 @@ To test locally, set `NODE_ENV=test`, or just remove the env var. - `docker-compose up` - Go to `http://localhost:8080/ghost/`. Create admin account if 1st time. Then go to Settings -> Advanced -> Lab -> Import and upload `output/blog.zip`. + +3. Configuration +There should be a .env file (for testing purpose) in the root of the project to configure host and s3. The file should look like this: + +```bash +BLOG_HOST=http://localhost:8080 +BLOG_STORAGE=s3 +BLOG_STORAGE_ACCESS_KEY_ID=AccessKeyId +BLOG_STORAGE_SECRET_ACCESS_KEY=SecretAccessKey +BLOG_STORAGE_REGION=Region +BLOG_STORAGE_BUCKET=Bucket +BLOG_STORAGE_ASSET_HOST=Url to access the files leading with // +BLOG_STORAGE_ENDPOINT=Endpoint without the protocol and bucket +``` +When running for production, the .env.production file should be in the root of the project.