mirror of
https://codeberg.org/Reuh/feather.git
synced 2025-10-27 10:09:32 +00:00
docs: update container image references
This commit is contained in:
parent
0e336cecda
commit
10b1b479ae
1 changed files with 8 additions and 6 deletions
14
README.md
14
README.md
|
|
@ -96,12 +96,12 @@ Since, as the kids say, everything is a file, Feather can be easily integrated w
|
|||
|
||||
### Docker
|
||||
|
||||
If use Docker or Podman, an image is available at `codeberg.org/TODO`.
|
||||
If use Docker or Podman, an image is available at `codeberg.org/reuh/feather:latest`.
|
||||
|
||||
For example, to start a new container with the Feather daemon running, using the `config.yml` (see [basic configuration](#basic-configuration)) in the current directory and exposing the feeds in the `reader` directory:
|
||||
|
||||
```sh
|
||||
docker run -d -v ./config.toml:/feather/config.toml:ro -v ./reader:/feather/reader -v feather-data:/feather/data --name feather TODO/feather daemon
|
||||
docker run -d -v ./config.toml:/feather/config.toml:ro -v ./reader:/feather/reader -v feather-data:/feather/data --name feather codeberg.org/reuh/feather:latest daemon
|
||||
```
|
||||
|
||||
Instead of using a configuration file, you may also use environment variables; see [the default configuration file](src/feather/config.default.toml) for details.
|
||||
|
|
@ -120,11 +120,11 @@ Description=Feather container
|
|||
|
||||
[Container]
|
||||
ContainerName=feather
|
||||
Image=feather
|
||||
Image=codeberg.org/reuh/feather:latest
|
||||
Exec=daemon
|
||||
|
||||
# Auto-update container TODO
|
||||
#AutoUpdate=registry
|
||||
# Auto-update container
|
||||
AutoUpdate=registry
|
||||
|
||||
# Configuration file
|
||||
Volume=%h/Feather/config.toml:/feather/config.toml:ro,Z
|
||||
|
|
@ -213,5 +213,7 @@ While I mostly started this project for fun, it ended up actually quite usable,
|
|||
|
||||
# TODO before publishing
|
||||
|
||||
- [ ] Write documentation
|
||||
- [x] Write documentation
|
||||
- [ ] Re-read
|
||||
- [ ] Tag v1.0 in git & container
|
||||
- [ ] Publish
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue