readmeDocker.md

Docker Guide For USERGE-X 🐳

Install docker

• Follow the official docker installation guide

Install Docker-compose

• Easiest way to install docker-compose is
  sudo pip install docker-compose
• Also you can check other official methods of installing docker-compose here

Run USERGE-X

• We dont need to clone the repo (yeah Docker-compose does that for us)
• Setup configs
  • Download the sample config file
    
    • mkdir userge-x && cd userge-x
    • wget https://raw.githubusercontent.com/code-rgb/userge-x/alpha/config.env.sample -O config.env
    • vim config.env
  • Download the yml file for docker-compose
    • wget https://raw.githubusercontent.com/code-rgb/userge-x/alpha/resources/docker-compose.yml
• Finally start the bot
  docker-compose up -d
• The bot should be running now
  Check logs with docker-compose logs -f

How to stop the bot

• Stop Command docker-compose stop

  • This will just stop the containers. Built images won't be removed. So next time you can start with docker-compose start command
    And it won't take time for building from scratch
    

• Down command docker-compose down

  • You will stop and delete the built images also. So next time you have to do docker-compose up -d to start the bot
    

Q&A

• How to see logs
  docker-compose logs -f
• How to update
  docker-compose up -d
  Changes will be fetched from git repo. You can change repo url from docker-compose.yml file