A docker-compose.yml file is provided for deployment with Docker compose, if you choose.
To use docker compose, you need to install the docker-compose-plugin. You can check whether it is already installed by running the following command.
sudo docker compose versionIf your version is 2.x or higher, then you are good. Otherwise, you should install the docker compose plugin. For a system like debian or ubuntu, you can use the following command.
sudo apt-get install docker-compose-pluginFor Mac OS, you can install docker desktop by downloading it from the docker website. After starting the application, the docker compose command becomes available in your terminal.
Depending on your setup, you may need to prefix every docker command with sudo.
The docker-compose.yml file uses a .env file in the same directory to load dynamic values used when the docker containers are initialized.
This is useful for setting up custom values locally. Additionally, your secrets (the mysql database credentials and admin user name) are inserted into the running container through the docker/env file.
Both the .env file and the docker/env file are gitignored, so you can change values to suit. These files need to be copied to the correct locations with some default values. You can do this in one step by executing a bash script.
# ensure script is executable, from the project root:
chmod +x docker/local-setup.sh
docker/local-setup.shEditing the ./.env file will modify the corresponding variables used in the docker-compose.yml file but NOT the environment variables in the container. Editing the ./docker/env file will change environment variables only in the running container.
Ensure config/database.yml has the username and password as defined in docker/env file. The config/database.yml should already be gitignored.
The COMMUNITY_NAME value defined in the .env file defines the initial community name on your local DB.
the COMMUNITY_ADMIN_USERNAME, COMMUNITY_ADMIN_PASSWORD and COMMUNITY_ADMIN_EMAIL values in the docker/env file define the first user you can log in as. Please note that the password should be at least 6 characters long.
Next, you should build the images.
docker compose buildIf you need to just rebuild one container, you can do that too.
docker compose build uwsgi
docker compose build db
docker compose build redisNOTE: If you get an error like "Cannot connect to the Docker daemon at ...", you need to ensure you start docker. Depending on your system, this can be done with sudo service docker start (Ubuntu) or by opening the Docker Desktop application and waiting for it to start (Mac OS).
Then start your containers!
docker compose up # append -d if you want to detach the processes, although it can be useful to see output into the terminal
Creating qpixel_redis_1 ... done
Creating qpixel_db_1 ... done
Creating qpixel_uwsgi_1 ... doneThe uwsgi container has a sleep command for 15 seconds to give the database a chance to start,
so don't expect to see output right away. After about 20 seconds, check to make sure the server is running (and verify port 3000, note that you can change this mapping in the .env file)
qpixel_uwsgi_1 | => Booting Puma
qpixel_uwsgi_1 | => Rails 7.0.4 application starting in development
qpixel_uwsgi_1 | => Run `rails server -h` for more startup options
qpixel_uwsgi_1 | Puma starting in single mode...
qpixel_uwsgi_1 | * Puma version: 5.6.5 (ruby 2.7.6-p219) ("Birdie's Version")
qpixel_uwsgi_1 | * Min threads: 5
qpixel_uwsgi_1 | * Max threads: 5
qpixel_uwsgi_1 | * Environment: development
qpixel_uwsgi_1 | * PID: 49
qpixel_uwsgi_1 | * Listening on http://0.0.0.0:3000
qpixel_uwsgi_1 | Use Ctrl-C to stop
You should then be able to open your browser to http://localhost:3000 and see the interface.
You can then click "Sign in" to login with what you defined for $COMMUNITY_ADMIN_EMAIL and $COMMUNITY_ADMIN_PASSWORD. Importantly, your password must be 6 characters or longer, otherwise the user won't be created.
Once you are logged in, you should see your icon in the top right:
Before you try to create a post we need to configure categories!
Go to http://localhost:3000/categories/
Click "edit" for each category and scroll down to see the "Tag Set" field. This will be empty on first setup.
You will need to select a tag set for each category! For example, the Meta category can be associated with the "Meta" tag set, and the Q&A category can be associated with "Main"
Make sure to click save for each one.
You should then be able to create a post! There are character requirements for the body and title, and you are required at least one tag.
And then click to "Save Post in Q&A"
That's it!
Running in this docker-compose setup, the system does not actually send emails. However, you can see the emails that would have been sent by going to http://localhost:3000/letter_opener. This is especially useful to confirm other accounts that you make in the container.
Often, it may be useful to run some ruby/rails code directly, e.g. for debugging purposes. You can do so with the following command:
$ docker compose exec uwsgi rails runner "<ruby code here>"
Running via Spring preloader in process 111It is also possible to open up a rails console to do more complicated things:
$ docker compose exec uwsgi rails cPlease keep in mind that for database related actions to work as expected, you first need to run the following in the rails console.
RequestContext.community = Community.firstThis correctly scopes all database actions to the first (and probably only) community in your system.
When you are finished, don't forget to clean up.
docker compose stop
docker compose rmThe current goal of this container is to provide a development environment for working on QPixel. This deployment has not been tested with email notifications enabled / set up, nor to deploy in production mode. If you require these modifications, please open an issue.