A Docker deployment for Steem FOSSbot Voter.
This repository consists of Docker build files, and a convenience script run.sh to simplify the voter bot code update process, and configuring of the voter Docker build files.
Voter actually contains it's own script docker-config.sh which is called by run.sh. The script sets up the voter environment variables from user prompted settings, which is similar to what you will find in the Create Server section of the Voter installation instructions.
So essentially this repo ties it all together without you having to have direct contact with the steem-fossbot-voter GitHub repo, it's automatically taken care of.
The helper script run.sh only runs on modern Linux (such as Ubuntu) or Mac OS X.
If you would like to port the script to Windows batch file, please make a pull request!
You will also need git installed, and of course Docker.
Clone this repository with
git clone https://github.com/Steem-FOSSbot/voter-docker.git
Follow the usage guide as normal, git processes are automatically handled.
Use the run.sh script for all operations. To run this in a terminal, navigate to the project folder, and type ./run.sh COMMAND, where COMMAND is one of the commands provided.
You should run setup and build first.
Note that all commands require Docker and for the Docker daemon to be started and running.
Run this the first time, and any time you want to update if you have git installed.
It will configure the Voter Docker scripts with your chosen environment variables. This variables are the custom information the Voter app needs to run on your Steem account.
You will be asked for:
- Cookie Secret
- Bot API key
- Your Steem username
- Your Steem private posting key
- How often you want the voter bot to run (e.g. every hour, or half hour, etc.)
You will also be prompted to optionally build now.
This updates the Voter code from the main repository but does not change the Docker configuration.
It is safe to run this and then rebuilt you Docker images without data loss.
Run this command only after setup.
It will build the Docker instance from the config files, and will take a while to complete.
You will not be prompted as it runs.
Starts the Docker instance and causes the bot to begin operation. This will start the dashboard web app interface at URL http://127.0.0.1:5000 and the bot will automatically run at the times you have configured in the setup.
If you use bgstart it will run as a background process, freeing up your terminal. However note that if on Mac, closing the terminal will end this process.
Please see:
- the dashboard guide for dashboard usage instructions
- the general usage guide to get started configuring the bot to vote as you like
If you used ./run.sh bgstart then ./run.sh bgstop to stop it, as it runs as a background service.
If you used ./run.sh start you should just stop the bot by using Ctrl+C or closing the terminal.
Shows the logs for the two Docker images running Node.js and Redis database. This is only useful when running voter-docker in background mode.
This is based on Docker instructions tutorial by @shaunmza available on Steemit here.
Special thanks to @someguy123 's great steem-docker project, of which the run.sh portion of this project is largely based. As per it's license, I am obliged to state the following:
run.sh in steem-docker was first modified on 4th March 2017 to create run.sh here in this project. Any further modifications of the source here will not be explicitly noted but are assumed read as git history.
Additionally we are forced to license this project under the same license, GNU GPL v3, and it is copyright to the organisation Steem FOSSbot.