Fix development environment with containers and backports custom public URLs

Docker.md → Container.md

@@ -1,36 +1,57 @@
-LinuxFr on Docker
------------------
+LinuxFr with Containers
+-----------------------
 
-To simplify set up of a developement environment, LinuxFr.org can be
-run on Docker with `docker compose up`.
+To simplify set up of a development environment, LinuxFr.org can be
+run with a container engine like Docker or Podman with the [`compose.yml`](./compose.yaml)
+file which describes how to build all needed services.
 
-To init the SQL database schema, you need to wait upto the `database`
-container to be ready to listen MySQL connections.
+By default, the LinuxFr.org services will be provided under the domain names
+`dlfp.lo` and `image.dlfp.lo`. So 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
+  ```
+
+Then, if you use the Docker engine, you can use the `docker compose up`
+command to start the system (you need to install the
+[Docker compose plugin](https://docs.docker.com/compose/) first).
+
+> Note: with the Docker engine, you need to enable the Docker BuildKit builder.
+> Either you have a Docker version which uses it by default, or you set the
+> environment variable `export DOCKER_BUILDKIT=1`.
+
+If you use the Podman engine, you can either use the same Docker compose plugin
+or the [podman-compose](https://github.com/containers/podman-compose/)
+tool. The podman cli itself provides a wrapper of one of these two tools
+through the
+[`podman compose` command](https://docs.podman.io/en/latest/markdown/podman-compose.1.html).
+Thus you need to use the `podman compose up` command to start the system.
+
+At this point, this documentation will give you `docker compose` commands,
+but you should be able to use `podman compose` without any issue.
+
+To setup the SQL database schema, you need to wait until the `database`
+container becomes 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       | 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".
+Or you can check the `database` container status to be *healthy* with the
+`docker compose ps` command.
 
 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](http://dlfp.lo)
+Finally, the environment is ready and you can open [http://dlfp.lo:9000](http://dlfp.lo:9000)
 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
 =========================
 
@@ -40,24 +61,22 @@ 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](https://docs.docker.com/compose/extends/)
-the docker compose configuration (in particular the `nginx` service for
-the port).
+Within the same file, you can update the HTTP listening ports by updating the
+`DOMAIN_HTTP_PORT` and `IMAGE_DOMAIN_HTTP_PORT` variables (both are set to 
+`9000` by default). If you modify them, don't forget to add the new values as
+published ports for the `nginx` service in the `compose.yaml` file (they have
+to target the `8080` container 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.
+You can also configure your own Redis service and your own MySQL
+service by updating environment variables in the same file.
 
 Test modifications
 ==================
 
-The docker compose is currently configured to share `./app`, `./db` and
-`./public` directories with the docker container.
+The compose file currently shares `./app`, `./db` and
+`./public` directories with the container.
 
-So you can update files with your prefered IDE on your machine. Rails
+So you can update files with your preferred 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
@@ -75,13 +94,13 @@ Run application tests
 =====================
 
 To help maintainers, we are in the process of adding tests to check the
-application has still the expected behaviour.
+application has still the expected behavior.
 
 To get help about writing tests, see the 
 [Ruby on Rails documentation](https://guides.rubyonrails.org/testing.html#the-rails-test-runner)
 .
 
-To run tests with Docker environment, you need to use this command:
+To run tests with containers, you need to use this command:
 
 ```
 docker compose exec linuxfr.org bin/rails test -v
@@ -114,10 +133,10 @@ use:
 docker compose exec linuxfr.org bin/rails db:reset
 ```
 
-Services provided by the docker compose
+Services provided by the compose file
 =======================================
 
-Currently, these services are directly enabled by docker compose:
+Currently, these services are directly enabled by compose:
 
 1. The [LinuxFr.org](https://github.com/linuxfrorg/linuxfr.org)
 ruby on rails application itself

INSTALL.md

@@ -153,11 +153,20 @@ Additionally, you run the boards within another terminal:
 
 This extra step isn't really needed to be able to use LinuxFr.org.
 
-In the `config/environments/development.rb` file, there are two domains set
-inside variables `MY_DOMAIN` and `IMG_DOMAIN`.
-By default both domains are `dlfp.lo`.
+In the `config/environments/development.rb` file, there are these variables:
 
-You'll find this domain inside some documents like emails to confirm user
+1. `MY_DOMAIN` and `IMG_DOMAIN` which define the domain name for the LinuxFr
+    service and the image caching service.
+    By default both domain names are `dlfp.lo`.
+
+2. `MY_PUBLIC_URL` and `IMG_PUBLIC_PORT` which define the public HTTP port for
+    both services.
+    By default both ports are `80`.
+
+These two set of variables are used to build the public url of the two
+services. By default both public urls are `http://dlfp.lo`.
+
+You'll find this public url inside some documents like emails to confirm user
 subscription. To simplify your usage of LinuxFr.org, you should consider
 install a website locally using this domain name.
 

README.md

@@ -12,9 +12,9 @@ Install
 
 See [INSTALL.md](INSTALL.md) to set up LinuxFr.org on a Debian environment.
 
-Alternatively, you can read [Docker.md](Docker.md) to setup easily
-LinuxFr.org development environment with the Docker engine and
-[docker-compose](https://docs.docker.com/compose/).
+Alternatively, you can read [Container.md](Container.md) to setup easily
+LinuxFr.org development environment with a container engine like Docker or
+Podman and use the [container composer](https://docs.docker.com/compose/).
 
 See also
 --------

app/controllers/admin/stylesheets_controller.rb

@@ -6,7 +6,7 @@ def show
 
   def create
     Stylesheet.temporary(current_account, params[:url]) do
-      redirect_to "/" + Stylesheet.capture("https://#{MY_DOMAIN}/", cookies)
+      redirect_to "/" + Stylesheet.capture("#{MY_PUBLIC_URL}/", cookies)
     end
   end
 

app/helpers/atom_helper.rb

@@ -5,7 +5,7 @@ def atom_comments_link(content, url)
     str = <<-EOS
     <p>
       <strong>Commentaires :</strong>
-      <a href=\"https://#{MY_DOMAIN}/nodes/#{content.node.id}/comments.atom\">voir le flux Atom</a>
+      <a href=\"#{MY_PUBLIC_URL}/nodes/#{content.node.id}/comments.atom\">voir le flux Atom</a>
       <a href=\"#{url}#comments\">ouvrir dans le navigateur</a>
     </p>
     EOS

app/models/diary.rb

@@ -80,7 +80,7 @@ def convert
       @news.save!
       $redis.set "convert/#{@news.id}", self.id
       @news.node.update_column(:cc_licensed, node.cc_licensed)
-      @news.links.create title: "Journal à l’origine de la dépêche", url: "https://#{MY_DOMAIN}/users/#{owner.to_param}/journaux/#{to_param}", lang: "fr"
+      @news.links.create title: "Journal à l’origine de la dépêche", url: "#{MY_PUBLIC_URL}/users/#{owner.to_param}/journaux/#{to_param}", lang: "fr"
       @news
     end
   end

app/models/image.rb

@@ -69,7 +69,7 @@ def src(type="img")
     return link if internal_link?
     return E403 if blacklisted?
     register_in_redis
-    "https://#{IMG_DOMAIN}/#{type}/#{encoded_link}/#{filename}"
+    "#{IMG_PUBLIC_URL}/#{type}/#{encoded_link}/#{filename}"
   end
 
   def src_attr

app/models/node.rb

@@ -178,7 +178,7 @@ def set_taglist(list, user_id)
         if tag.new_record?
           tag.save!
           user = User.find(user_id)
-          Board.amr_notification("L’étiquette #{tagname} https://#{MY_DOMAIN}/tags/#{tagname}/public vient d’être créée par #{user.name} https://#{MY_DOMAIN}/users/#{user.cached_slug}")
+          Board.amr_notification("L’étiquette #{tagname} #{MY_PUBLIC_URL}/tags/#{tagname}/public vient d’être créée par #{user.name} #{MY_PUBLIC_URL}/users/#{user.cached_slug}")
         end
         taggings.create(tag_id: tag.id, user_id: user_id)
       end

app/uploaders/avatar_uploader.rb

@@ -3,7 +3,7 @@
 class AvatarUploader < CarrierWave::Uploader::Base
 
   AVATAR_SIZE = 64
-  DEFAULT_AVATAR_URL = "https://#{MY_DOMAIN}/images/default-avatar.svg"
+  DEFAULT_AVATAR_URL = "#{MY_PUBLIC_URL}/images/default-avatar.svg"
 
   include CarrierWave::MiniMagick
   process resize_and_pad: [AVATAR_SIZE, AVATAR_SIZE]
@@ -13,7 +13,7 @@ def base_dir
   end
 
   def url
-    super.sub(base_dir.to_s, "https://#{IMG_DOMAIN}")
+    super.sub(base_dir.to_s, "#{IMG_PUBLIC_URL}")
   end
 
   def store_dir

app/uploaders/stylesheet_uploader.rb

@@ -6,7 +6,7 @@ def base_dir
   end
 
   def url
-    super.sub(base_dir.to_s, "https://#{IMG_DOMAIN}")
+    super.sub(base_dir.to_s, "#{IMG_PUBLIC_URL}")
   end
 
   def store_dir

app/views/bookmarks/_bookmark.atom.builder

@@ -8,5 +8,5 @@ feed.entry(bookmark, :url => url) do |entry|
   bookmark.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{bookmark.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{bookmark.node.id}/comments.atom"
 end

app/views/diaries/_diary.atom.builder

@@ -12,5 +12,5 @@ feed.entry(diary, :url => url) do |entry|
   diary.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{diary.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{diary.node.id}/comments.atom"
 end

app/views/news/_news.atom.builder

@@ -7,7 +7,7 @@ feed.entry(news, :published => news.node.created_at) do |entry|
   first  = content_tag(:div, news.body)
   links  = content_tag(:ul, news.links.map.with_index do |l,i|
              content_tag(:li, "lien nᵒ #{i+1} : ".html_safe +
-                              link_to(l.title, "https://#{MY_DOMAIN}/redirect/#{l.id}", :title => l.url, :hreflang => l.lang))
+                              link_to(l.title, "#{MY_PUBLIC_URL}/redirect/#{l.id}", :title => l.url, :hreflang => l.lang))
            end.join.html_safe)
   second = content_tag(:div, news.second_part)
   if news.published?
@@ -32,6 +32,6 @@ feed.entry(news, :published => news.node.created_at) do |entry|
     entry.category(:term => tag.name)
   end
   if news.published?
-    entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{news.node.id}/comments.atom"
+    entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{news.node.id}/comments.atom"
   end
 end

app/views/polls/_poll.atom.builder

@@ -9,5 +9,5 @@ feed.entry(poll, :published => poll.node.created_at) do |entry|
   poll.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{poll.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{poll.node.id}/comments.atom"
 end

app/views/posts/_post.atom.builder

@@ -10,5 +10,5 @@ feed.entry(post, :url => url) do |entry|
   post.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{post.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{post.node.id}/comments.atom"
 end

app/views/stylesheets/edit.html.haml

@@ -33,7 +33,7 @@
     Pour cela, il vous suffit de commencer votre feuille de style par la déclaration suivante :
 
   %pre
-    @import url("https://#{MY_DOMAIN}/assets/application.css");
+    @import url("#{MY_PUBLIC_URL}/assets/application.css");
 
   %div.sideforms
     = form_tag "/stylesheet", method: :put do

app/views/trackers/_tracker.atom.builder

@@ -8,5 +8,5 @@ feed.entry(tracker) do |entry|
   tracker.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{tracker.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{tracker.node.id}/comments.atom"
 end

app/views/wiki_pages/_wiki_page.atom.builder

@@ -9,5 +9,5 @@ feed.entry(wiki_page) do |entry|
   wiki_page.node.popular_tags.each do |tag|
     entry.category(:term => tag.name)
   end
-  entry.wfw :commentRss, "https://#{MY_DOMAIN}/nodes/#{wiki_page.node.id}/comments.atom"
+  entry.wfw :commentRss, "#{MY_PUBLIC_URL}/nodes/#{wiki_page.node.id}/comments.atom"
 end