Run PixelCore using Docker
This Quick Start Guide will help you get the PixelCore Platform up & running. At the moment the Platform can be started as a SaaS service on PixelCloud or locally on your computer as Docker containers using Docker Compose.
In case you’d like to run PixelCore locally on your computer, please follow the instructions below.
Prerequisites:
- Docker
- Docker Compose
- make
Step 1: Get the docker-compose file¶
The pixelcore/platform repo contains docker-compose file and other scripts required to deploy the Platform. Clone the repository to start:
$ git clone https://pixel:public21@gl.thingularity.online/pixelcore/platform.git
Step 2: Run PixelCore docker-compose¶
You would need to run make to generate passwords and execute other supplementary stuff including docker-compose.
$ cd platform/stand-alone
$ make
Check if the containers are up & running. The exact list of containers may differ from version to version.
Note
You may use make stop and make start commands to restart all containers. To pull up-to-date version of the platform you may use make stop pull start. To clean up things completely (including removal of database, password generated file and so on) run make clean. Of course you can use docker-compose command for more precise control and if you know what you are doing.
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
bdcfad17cbc4 pixelcore.azurecr.io/loradrivers:latest "./loradrivers" 22 hours ago Up 3 minutes pix-loradrivers
296b60671444 pixelcore.azurecr.io/pix-http-bridge:latest "/bin/sh -c 'sleep 2…" 22 hours ago Up 3 minutes 0.0.0.0:5060->5060/tcp pix-http-bridge
1152aa1ad611 pixelcore.azurecr.io/tnbridge:latest "./tnbridge" 22 hours ago Up 3 minutes pix-tnbridge
7df13ab27bde pixelcore.azurecr.io/pix-apps:latest "/docker-entrypoint.…" 22 hours ago Up 3 minutes 0.0.0.0:5080->80/tcp, 0.0.0.0:5081->81/tcp, 0.0.0.0:5083->83/tcp pix-apps
89c12e1bb315 pixelcore.azurecr.io/pix-business-logic-dispatcher:latest "/bin/sh -c 'sleep 1…" 22 hours ago Up 3 minutes pix-dispatcher
8cad27374e1e pixelcore.azurecr.io/pix-media-server:latest "/bin/sh -c 'sleep 2…" 22 hours ago Up 3 minutes 0.0.0.0:5001->3000/tcp pix-media-server
863ed97ff350 pixelcore.azurecr.io/pix-core-api:latest "./entrypoint.sh" 22 hours ago Up 3 minutes 0.0.0.0:5000->5000/tcp pix-core-api
4932a62bd139 pixelcore.azurecr.io/pix-core:latest "/graphile-migrate/d…" 22 hours ago Up 3 minutes 0.0.0.0:5432->5432/tcp pix-core
Step 3: Access PixelAdmin¶
Head to http://localhost:5080/ to open the PixelAdmin. Login with user admin and autogenerated password stored in platform/stand-alone/.env file (look for ADMIN_PASSWORD=<secret> line).
Now you may access the application. For more information on PixelAdmin functionality please refer to the corresponding section of the documentation. The online documentation is also available at http://localhost:8080/.
Please take care about platform/stand-alone/.env file, it supposed to be stored in safe place since it contains all autogenerated passwords used within the PixelCore. Below you may find list of useful accounts information with matching passwords.
| Username | .env File Password Variable Name |
Description |
|---|---|---|
| postgres | $PG_PASSWORD |
PostgreSQL master account |
| admin@pixelcore.local | $PGADMIN_PASSWORD |
PGAdmin account |
| admin | $ADMIN_PASSWORD |
PixelAdmin admin account |
| media_server | $PGMEDIASERVER_PASSWORD |
PostgreSQL media server account |
| tnbridge | $TNBRIDGE_PASSWORD |
PixelLNS bridge account |
| httpbridge | $HTTPBRIDGE_PASSWORD |
PixelCore HTTPBridge account |
| loradrivers | $LORADRIVERS_PASSWORD |
PixelCore DriversPack account |
| admin_worker | $ADMIN_WORKER_PASSWORD |
PixelCore Dispatcher account |
| user_management_worker | $USER_MANAGEMENT_WORKER_PASSWORD |
PixelCore Dispatcher User Management account |
| dispatcher | $DISPATCHER_PASSWORD |
PixelCore Dispatcher master account |
| n/a | $JWTSECRET_PASSWORD |
JWT Secret key for JWT/Postgraphile |