Skip to content
Open
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,9 @@ dist/
._*
github_token
/nom

# local dev/docker artifacts referenced in README docs
config.yml
my-nom-config.yml
nom.db
nom-data/
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,14 @@ And you cannot combine simple keyword searches with any qualifiers:

## Building and Running via Docker

> **Windows (Git Bash):** Git Bash rewrites `/app/...` paths in `-v` flags as if they were local Windows paths, which breaks volume mounts. Prefix `docker run` commands with `MSYS_NO_PATHCONV=1` to disable this, e.g.:
> ```sh
> MSYS_NO_PATHCONV=1 docker run --rm -it \
> -v "$(pwd)/my-nom-config.yml":/app/docker-config.yml \
> -v "$(pwd)/nom-data":/data \
> ghcr.io/guyfedwards/nom:master
> ```

Build nom image

```sh
Expand Down Expand Up @@ -299,6 +307,25 @@ Available tags:
- `x.y.z` / `x.y` - pinned release versions (e.g. `3.0.0`)
- `sha-<short-sha>` - exact commit builds

### Persisting the database

The container has no `XDG_CONFIG_HOME`, so nom resolves the sqlite file relative to its working directory by default. To persist read state and cached articles across container restarts, mount a directory and point `database` at an absolute path inside it in your config:

```yaml
# my-nom-config.yml
database: /data/nom.db
```

```sh
mkdir -p nom-data
docker run --rm -it \
-v $PWD/my-nom-config.yml:/app/docker-config.yml \
-v $PWD/nom-data:/data \
ghcr.io/guyfedwards/nom:master
```

Don't `touch` the db file yourself and bind-mount it directly - nom only runs its initial table setup when the file doesn't exist yet, so a pre-created empty file leaves the database schemaless.

## Dev setup

You can use `backends-compose.yml` to spin up a local instance of [MiniFlux] and [FreshRSS] if needed for development.
Expand Down
Loading