~gpanders/pushbroom

f0e4ca94cb2bd8b398b0cc8239178f91c6b72a9d — Greg Anders 2 years ago 675e418
Add systemd service and update README
2 files changed, 37 insertions(+), 1 deletions(-)

M README.md
A contrib/systemd/pushbroom.service
M README.md => README.md +29 -1
@@ 30,7 30,7 @@ Pushbroom will run once every hour.

Install using pip:

    pip install pushbroom
    pip install --user pushbroom

### From source



@@ 43,6 43,14 @@ locations:
    cp -r bin /usr/local/
    cp -n pushbroom.conf ~/.config/pushbroom/config

## Usage

Pushbroom can be run from the command line using:

    pushbroom

Use `pushbroom --help` to see a list of command line options.

## Configuration

The Pushbroom configuration file is organized into sections where each section


@@ 98,6 106,26 @@ Number of days to keep files in `Path` before they are removed.

Glob expression pattern of files or directories to ignore.

## Automating

If installed via Homebrew then Pushbroom can be set to run once every hour using

    brew services start gpanders/tap/pushbroom

Another option is to install a crontab entry

    0 */1 * * * /usr/local/bin/pushbroom

If you are using a Linux distribution that uses systemd, you can copy the
[systemd service
file](https://github.com/gpanders/pushbroom/blob/master/contrib/systemd/pushbroom.service)
to `~/.local/share/systemd/` and enable the service with

    systemctl --user enable --now pushbroom

Note that you may need to change the path to the `pushbroom` script in the
service file depending on your method of installation.

## Similar Work

- [Belvedere](https://github.com/mshorts/belvedere): An automated file manager

A contrib/systemd/pushbroom.service => contrib/systemd/pushbroom.service +8 -0
@@ 0,0 1,8 @@
[Unit]
Description=Pushbroom

[Service]
User=%I
Restart=always
RestartSec=3600s
ExecStart=/usr/local/bin/pushbroom