diff --git a/.env.example b/.env.example index cf243be..967ab14 100644 --- a/.env.example +++ b/.env.example @@ -1,6 +1,5 @@ -# Reddit Bot Docker Environment Configuration +# ModReplyBot Docker Environment Configuration -# .env file example (for Docker) REDDIT_CLIENT_ID=your_client_id REDDIT_CLIENT_SECRET=your_client_secret REDDIT_USERNAME=your_username @@ -8,5 +7,3 @@ REDDIT_PASSWORD=your_password REDDIT_USER_AGENT=modbot by /u/your_username REDDIT_SUBREDDIT=your_subreddit REDDIT_WIKI_PAGE=modbot-config - -# Add this file to .gitignore if you commit your project diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c49bd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.env diff --git a/README.md b/README.md index d30c2e7..3ab0feb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ModBot Reddit Bot +# ModReplyBot Reddit Bot This bot watches a subreddit for moderator reports containing triggers, approves posts, and leaves stickied comments. Triggers and comments are configured via a subreddit wiki page. All other settings are handled via environment variables. @@ -12,7 +12,7 @@ This bot watches a subreddit for moderator reports containing triggers, approves ## Configuration ### 1. Subreddit Wiki Page -Create a wiki page (e.g. `modbot-config`) in your subreddit using Automoderator YAML format. Example: +Create a wiki page (e.g. `modreplybot-config`) in your subreddit using Automoderator YAML format. Example: ``` triggers: @@ -37,9 +37,9 @@ REDDIT_CLIENT_ID=your_client_id REDDIT_CLIENT_SECRET=your_client_secret REDDIT_USERNAME=your_username REDDIT_PASSWORD=your_password -REDDIT_USER_AGENT=modbot by /u/your_username +REDDIT_USER_AGENT=modreplybot by /u/your_username REDDIT_SUBREDDIT=your_subreddit -REDDIT_WIKI_PAGE=modbot-config +REDDIT_WIKI_PAGE=modreplybot-config ``` ## Installation diff --git a/docker-compose.yml b/docker-compose.yml index 6e4a38c..0f6e73b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,6 +2,7 @@ version: '3.8' services: modbot: image: slfhstd.uk/slfhstd/modreplybot:latest + container_name: modreplybot env_file: - .env restart: unless-stopped diff --git a/modbot.py b/modreplybot.py similarity index 100% rename from modbot.py rename to modreplybot.py