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

Move example configs to their own folder #99

Merged
merged 1 commit into from
Feb 26, 2023
Merged
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: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ That's a bad precondition for maintaining a project. So if there is anyone who i
constraints:
- node.role == manager

See the example [docker-compose.yml](docker-compose.yml) and some more compose configs in the [examples](examples) folder.

## Configuration

Shepherd will try to update your services every 5 minutes by default. You can adjust this value using the `SLEEP_TIME` variable.
Expand Down Expand Up @@ -89,7 +91,7 @@ You can enable connection to insecure private registry by setting the `WITH_INSE

You can force image deployment whatever the architecture by setting the `WITH_NO_RESOLVE_IMAGE` variable.

You can enable notifications on service update with apprise, using the [apprise microservice](https://github.com/djmaze/apprise-microservice) and the `APPRISE_SIDECAR_URL` variable. See the file [docker-compose.apprise.yml](docker-compose.apprise.yml) for an example.
You can enable notifications on service update with apprise, using the [apprise microservice](https://github.com/djmaze/apprise-microservice) and the `APPRISE_SIDECAR_URL` variable. See the file [docker-compose.apprise.yml](examples/docker-compose.apprise.yml) for an example.

You can enable old image autocleaning on service update by setting the `IMAGE_AUTOCLEAN_LIMIT` variable.

Expand Down Expand Up @@ -124,7 +126,7 @@ When running shepherd as described with a `SLEEP_TIME`, the de facto running tim
1. Create a *swarm-cronjob* service [as described in its documentation](https://crazymax.dev/swarm-cronjob/install/docker/#usage).
2. Set `RUN_ONCE_AND_EXIT` to `true`, `replicas` to `0` and `restart_policy` to `condition: none`. Add docker labels for the schedule.

See [docker-compose.swarm-cronjob.yml](docker-compose.swarm-cronjob.yml) for a full stack example which includes both shepherd as well as swarm-cronjob.
See [docker-compose.swarm-cronjob.yml](examples/docker-compose.swarm-cronjob.yml) for a full stack example which includes both shepherd as well as swarm-cronjob.

## How does it work?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ version: "3"

services:
app:
build: .
image: mazzolino/shepherd
environment:
APPRISE_SIDECAR_URL: notify:5000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ version: "3"

services:
app:
build: .
image: mazzolino/shepherd
environment:
TZ: 'US/Eastern'
Expand Down