Skip to content

Commit

Permalink
Update docker info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
wezm committed Jul 31, 2024
1 parent b20fc1f commit 26d4061
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,6 @@ Feedlynx is packaged in these package managers:

See [Build From Source](#build-from-source) below.

### Using a Container (Docker or Podman)

A Dockerfile is included in the repository. A leightweight container image can be built like this:

docker build -t feedlynx .

The Container expects the .yml file in /data so we can use a volume mount to have persistent storage:

docker run -p 8001:8001 -v ./data:/data -e FEEDLYNX_PRIVATE_TOKEN=ExampleExampleExampleExample1234 -e FEEDLYNX_FEED_TOKEN=FeedFeedFeedFeedFeedFeedFeedFeed localhost/feedlynx

The application then can be accessed at localhost port 8001 like it would run without a container.
If using podman, just replace the usage of the docker command with podman.

Integrations
------------

Expand Down Expand Up @@ -210,6 +197,24 @@ To build with `native-tls` invoke Cargo as follows:
If packaging Feedlynx for an operating system registry it might make sense to
use `native-tls`. On Linux and BSD systems that adds a dependency on OpenSSL.

### Using a Container (Docker or Podman)

A Dockerfile is included in the repository. A lightweight container image can
be built like this:

docker build -t feedlynx .

The container expects the path to the feed in `/data`, so we can use a volume
mount to have persistent storage:

docker run -p 127.0.0.1:8001:8001 -v ./data:/data \
-e FEEDLYNX_PRIVATE_TOKEN=ExampleExampleExampleExample1234 \
-e FEEDLYNX_FEED_TOKEN=FeedFeedFeedFeedFeedFeedFeedFeed /data/feed.xml

The application then can be accessed at <http://localhost:8001> like it would
run without a container. If using Podman, just replace the usage of the
`docker` command with `podman`.

Credits
-------

Expand Down

0 comments on commit 26d4061

Please sign in to comment.