Skip to content

Commit

Permalink
📝 Update README about configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
zbcjackson committed Mar 1, 2024
1 parent 21f00f1 commit 623b763
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 623b763

Please sign in to comment.