Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 2.26 KB

File metadata and controls

27 lines (17 loc) · 2.26 KB

Requeriments

Docker Service

At the moment the default configuration when the run_server butler command uses docker containers to run the PostgreSQL, RabbitMQ, and Minio services. It is mandatory to have Docker service installed in case the default configuration is used. To install Docker, you can refer to the official installation instructions Install Docker Engine:

Python

To run the backend server and the Pingu bot, it is necessary to have the latest Python version installed on your system.

Node.js

By default, in order to execute the Pingu Frontend, the framework uses NodeJS.

Deployment steps

  1. Sync Submodules: First of all, as the project is fragmented into multiple git submodules, once the PinguCrew project is cloned, it will be necessary to run the following git command to sync the rest of the git submodules.
git submodule update --init
  1. Install Dependencies: Instead of manually installing all the dependencies, use the butler bootstrap command.
  2. Setup Configuration Files: The configuration files located in the configs/ directory are automatically set up during the deployment process. There is no need to manually modify these files unless specific customizations are required.
  3. Run Backend Server: The easiest way to run the backend service is by using the run_server butler command line bootstrap command. The Butler assistant will ensure that all backend components, including PostgreSQL, RabbitMQ, and Minio, are initialized for you.
  4. Bot Tokens: Bot tokens are now auto-generated when a new bot is created using the dashboard. There is no need to manually generate or configure tokens during deployment.
  5. Run Frontend Server: The easiest way to run the frontend dashboard is by using the run_web butler command. At this point, it is possible to create a dashboard user by using the Django Admin dashboard or directly using the registration form on the login page.