Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HadManySons authored Mar 10, 2024
1 parent bfb3034 commit 60543d2
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ Reddit bot that searches /r/AirForce looking for AFI/Forms/Publication mentions

[![Docker Image CI](https://github.com/HadManySons/AFILinkerBot/actions/workflows/docker-image.yml/badge.svg?branch=master)](https://github.com/HadManySons/AFILinkerBot/actions/workflows/docker-image.yml)

Usage:
# Run
## To run the latest image from docker, execute:

1. 'pip install -r requirements.txt'
`cd AFILinkerBot`

2. Fill in the appropriate credentials in the BotCreds.py file
`docker build -t afilinkerbot .`

3. Change the subreddit variable from 'AFILinkerBot' to the subreddit of your choice
`docker run -d --name afexcuses -v AFexcuses:/app --restart unless-stopped --env-file ./AFE_ENVS.list afilinkerbot`

4. Run scripts
`--restart unless-stopped` is optional, only needed if you want the bot to survive errors.

`--env-file ./AFE_ENVS.list` needs to be populated with the bot creds, the excuse file name and the subreddits

0 comments on commit 60543d2

Please sign in to comment.