Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sosweetham committed May 5, 2024
1 parent 0b387f8 commit 12591c6
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# PhotoBox
PhotoBox is a Guilded based avatar/banner CDN cache. Powered by ElysiaJS, Minio and Bun.

Open http://localhost:3000/ with your browser to see the result.
Open http://localhost:3000/ with your browser to see the result.

# How to use
Refer to [docs](https://photobox.cardboard.ink/swagger)

# How to run
1. Setup the environment file, fill any random value for minio access and secret.
2. Run only minio service.
> `docker compose up photobox-minio1`
3. Login according to env config and setup access.
4. Copy minio access and secret to env file.
5. Restart compose with all containers.
> `docker compose down --remove-orphans && docker compose up --build -d`

0 comments on commit 12591c6

Please sign in to comment.