getting started

requirements

• docker and docker compose installed on your system
• a telegram bot token from @botfather
• (optional) telegram api id and api hash from my.telegram.org, if you plan to use a self-hosted bot api

installation

1. clone the repository:

   git clone https://github.com/crocchetto/crovd.git && cd crovd

2. create and edit the .env file to match your setup. make sure the database host is set to:

   DB_HOST=db
   

   at minimum, you need to set the following variables:

   variable	description
   BOT_TOKEN	your telegram bot token from @botfather
   DB_HOST	database host, must be db when using docker
   DB_USER	database username
   DB_PASSWORD	database password
   DB_NAME	database name

   refer to .env.example for all available options.

3. start all services with docker:

   docker compose up -d