Reuh/feather
1
0
Fork 0
mirror of https://codeberg.org/Reuh/feather.git synced 2025-10-27 10:09:32 +00:00
Code Releases Activity

docs: update container image references

Browse source
This commit is contained in:
Étienne Fildadut 2025-10-15 16:09:35 +02:00
parent 0e336cecda
commit 10b1b479ae
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -96,12 +96,12 @@ Since, as the kids say, everything is a file, Feather can be easily integrated w
### Docker ### 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: 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 ```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. 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] [Container]
ContainerName=feather ContainerName=feather
Image=feather Image=codeberg.org/reuh/feather:latest
Exec=daemon Exec=daemon
# Auto-update container TODO # Auto-update container
#AutoUpdate=registry AutoUpdate=registry
# Configuration file # Configuration file
Volume=%h/Feather/config.toml:/feather/config.toml:ro,Z 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 # TODO before publishing
- [ ] Write documentation - [x] Write documentation
- [ ] Re-read
- [ ] Tag v1.0 in git & container
- [ ] Publish - [ ] Publish