Skip to content

Latest commit

 

History

History
143 lines (101 loc) · 4.67 KB

Docker.md

File metadata and controls

143 lines (101 loc) · 4.67 KB
Raw

LinuxFr on Docker

To simplify set up of a developement environment, LinuxFr.org can be run on Docker with docker compose up.

To init the SQL database schema, you need to wait upto the database container to be ready to listen MySQL connections.

For example, you should see in the logs:

database_1 | 2020-09-21 16:03:12 139820938893312 [Note] mysqld: ready for connections.

database_1 | Version: '10.1.46-MariaDB-1~bionic' socket: '/var/run/mysqld/mysqld.sock' port: 3306 mariadb.org binary distribution

Or you can check the database container status to be "healthy".

Then, open a second terminal and run:

docker compose exec linuxfr.org bin/rails db:setup

Finally, the environment is ready and you can open http://dlfp.lo in your favorite browser.

Note: to be able to access this URL, you'll need to add the following line into the /etc/hosts file of your machine:

127.0.0.1 dlfp.lo image.dlfp.lo

Personalize configuration

By default, you don't need to update the configuration.

If you want, you can change the domain names used by the LinuxFr.org web application. To do this, you can setup DOMAIN and IMAGE_DOMAIN variables in the deployment/default.env file.

You can also configure your own Redis service and your own MySQL service.

If you want to change the application port and/or other configurations, you can override the docker compose configuration (in particular the nginx service for the port).

Notice, that if LinuxFr.org doesn't run on port 80, the image cache service won't work well and so you won't be able to see images in the news.

Test modifications

The docker compose is currently configured to share ./app, ./db and ./public directories with the docker container.

So you can update files with your prefered IDE on your machine. Rails will directly detect changes and apply them on next page reload.

Furthermore, if you need to access the Rails console, you need a second terminal and run:

docker compose exec linuxfr.org bin/rails console

Note: currently, we didn't configure rails to show directly the webconsole in your browser. That's just because of time needed to find the good configuration, any help will be appreciated !

Run application tests

To help maintainers, we are in the process of adding tests to check the application has still the expected behaviour.

To get help about writing tests, see the Ruby on Rails documentation .

To run tests with Docker environment, you need to use this command:

docker compose exec linuxfr.org bin/rails test -v

Inspect the database schema

In case you need to inspect the database, the port 3306 of your machine is by default bound to the port 3306 of the database container.

Thus you can connect to the linuxfr database with hostname localhost and the username, password and database name defined in the deployment/default.env configuration file (all three last are by default linuxfr_rails).

Apply database migrations

In case you need to apply new database migrations, you need a second terminal and run:

docker compose exec linuxfr.org bin/rails db:migrate

If you had issue and want to reset all data in your database system, use:

docker compose exec linuxfr.org bin/rails db:reset

Services provided by the docker compose

Currently, these services are directly enabled by docker compose:

  1. The LinuxFr.org ruby on rails application itself
  2. The board service which is responsible of tribunes and dynamic collaborative editions of news
  3. The image service which is caching external images to avoid to run DOS on external services hosting the images used in news, diaries...

For now, these services aren't available:

  1. The epub service, because it requires to run LinuxFr.org with a TLS certificate. When the service will accept to fetch articles with simple http://, we'll be able to provide it directly with docker compose.
  2. The svgtex service, because LinuxFr has hard-coded the localhost hostname in it's HTML Pipeline tool

Fortunately, you can already hack LinuxFr.org deeply without these services.