Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.28 KB

running-pageonex-locally-with-docker-compose.md

File metadata and controls

71 lines (49 loc) · 2.28 KB

Running pageonex locally with docker compose

You can test locally pageonex using docker compose.

From the command line go to the direcrtory where you have cloned (or downloaded) the Pageonex repository and type:

docker-compose up

It will take a few minutes to complet the install. You need Internet access because it needs to download the PageOneX docker image.

Once it works you will get:

Once everything is running correctly, you can access the application from your browser at http://localhost:3000 or http://0.0.0.0:3000

For Windows users

You need to enable virtualization to allow docker work. See the example for Windows 11: https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-11-pcs-c5578302-6e43-4b4b-a449-8ced115f58e1

Tasks

How to run in detached mode

In order to run docker-compose in background and have the shell available, please use detached mode

docker-compose up -d

How to see logs

Logs are not shown in the screen in detached mode, you can inspect them using

docker-compose logs

How to access the rails console

To get a the rails console (See doc/local-install.md for instructions on creating an admin user) run

docker-compose exec app rails console

How to access the database

In case you want to further inspect the database, you can run

docker-compose exec mysql mysql -u root -h localhost --password=root dc-prod

How to shut it down

If you want to shut down everything, keeping volumes and images for a quick start

docker-compose stop

How to delete everything and start from scratch

You may want to start fresh. You have to make sure that all related images, containers are both stopped and deleted and volumes are deleted

docker-compose stop
docker-compose rm
docker volume rm pageonex_app_kiosko_images pageonex_app_threads_images pageonex_db_data pageonex_app_tmp_dir