Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add docker compose example #47

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: add docker compose example
pbek authored May 7, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 5e0ad9993023dd5d487f46b4275837de3a1efb01
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -27,6 +27,28 @@ And yes, it works on macOS too!
- **Scalabilty**: Attic can be easily replicated. It's designed to be deployed to serverless platforms like fly.io but also works nicely in a single-machine setup.
- **Garbage Collection**: Unused store paths can be garbage-collected in an LRU manner.

## Docker compose example

To use this you need to create a `./attic/server.toml` with your config pointing to the other directories.
You also need to create an empty `./attic/server.db` that atticd can take over.

```yaml
version: '3.7'
services:
attic:
image: ghcr.io/zhaofengli/attic:latest
volumes:
- ./attic/server.toml:/attic/server.toml
- ./attic/server.db:/attic/server.db
- attic-storage:/attic/storage
command: [ "-f", "/attic/server.toml" ]
ports:
- 8080:8080

volumes:
attic-storage:
```

## Licensing

Attic is available under the **Apache License, Version 2.0**.