Provide a Docker Compose example #1168

virtualtam · 2018-06-26T23:34:04Z

Tested on a DigitalOcean Droplet (cheapest one: 1 vCPU, 1 GiB RAM, 25 GiB SSD)

See:

ArthurHoaro · 2018-06-30T11:22:26Z

I had an issue with jwilder's nginx proxy because it doesn't set the X-Forwarded-Host header by default (see), and I had to manually add it, otherwise the SERVER_NAME was blank. Maybe there is an easier solution though.

Also, is it possible to put the docker-composer files under .docker directory?

virtualtam · 2018-06-30T23:05:51Z

X-Forwarded-Host

That's right, I usually override this as well on a per-virtualhost basis. The main doc looks obsolete, as Nginx configuration is generated by docker-gen using a template that is deployed to /app/nginx.tmpl and can be overridden by bind-mounting (argh!) a custom template. This is definitely not ideal as I would like to go for a simple solution to get users started.

I'll look into alternatives such as Træfik and Caddy(https://caddyserver.com/), which are cloud-ready and come with Let's Encrypt support out-of-the-box.

put docker-compose files under .docker directory

.docker contains deployment resources used when building Docker images, so it should not feature Compose configuration.

On a more subjective perspective, I like to find docker-compose.yml besides a Dockerfile when looking at source code, as it shows that maintainers have put in the effort of packaging their software for Docker, and provide an example with Compose, that users can use and potentially tweak to fit their use-case.

I don't know where the .env file should live though; docker-compose has a flag to select the YAML configuration file, but none for choosing an alternate environment file (short of declaring environment variables on the command-line - again, not ideal for the sake of simplicity).

virtualtam · 2018-07-01T01:22:23Z

Træfik alternative in #1170, tested on the cheapest DigitalOcean Droplet (VPS) available :)

virtualtam · 2018-07-01T14:12:46Z

PR reworked with Træfik, along with a guide on how to setup a VPS with Docker, Compose and Shaarli images :)

nodiscc · 2018-07-07T16:31:53Z

doc/md/guides/install-shaarli-with-debian9-and-docker.md

+
+- [Droplets Overview](https://www.digitalocean.com/docs/droplets/overview/)
+- [Pricing](https://www.digitalocean.com/pricing/)
+- [How to Create a Droplet from the DigitalOcean Control Panel ](https://www.digitalocean.com/docs/droplets/how-to/create/)


extra space Panel ](http

nodiscc · 2018-07-07T16:32:29Z

doc/md/guides/install-shaarli-with-debian9-and-docker.md

+(HTTP with TLS encryption).
+
+Domain names can be obtained from registrars through hosting providers such as
+[Gandhi](https://www.gandi.net/en/domain).


nodiscc · 2018-07-07T16:36:30Z

doc/md/guides/install-shaarli-with-debian9-and-docker.md

+```
+
+### Setting up Docker Compose
+_The following instructions are from the


Github's syntax highlighting is somehow broken, even though https://github.com/virtualtam/Shaarli/blob/a608109ec13b0b79afd53f6ad8695c7da09ee15c/doc/md/guides/install-shaarli-with-debian9-and-docker.md displays properly

In addition a short introductory sentence about what docker compose is/does would be nice:

Docker Compose is a tool for defining and running multi-container Docker applications. It uses YAML files to configure the application's services and performs the creation and start-up process of all the containers with a single command.

I fear adding to much information would clutter the guides, though links to Docker and Compose documentation could be featured in the "Goals" introductory section

nodiscc · 2018-07-07T16:39:47Z

doc/md/guides/install-shaarli-with-debian9-and-docker.md

+- [Get Docker CE for Debian](https://docs.docker.com/install/linux/docker-ce/debian/)
+- [docker logs](https://docs.docker.com/engine/reference/commandline/logs/)
+- [Volumes](https://docs.docker.com/storage/volumes/)
+- [Install Docker Compose](Install Docker Compose)


Broken link

nodiscc · 2018-07-07T16:41:21Z

mkdocs.yml

-    - Backup, restore, import and export: Backup,-restore,-import-and-export.md
-    - Various hacks: Various-hacks.md
+- Guides:
+    - Install Shaarli on Debian 9 with Docker: guides/install-shaarli-with-debian9-and-docker.md


page title and filename do not match

they don't have to, this makes for nicer page slugs when generating the docs

Closes shaarli#1010 See: - https://hub.docker.com/_/traefik/ - https://docs.traefik.io/configuration/backends/docker/ - https://docs.traefik.io/user-guide/docker-and-lets-encrypt/ - traefik/traefik#2798 - traefik/traefik#3298 Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam · 2018-07-12T20:10:58Z

PR updated; @nodiscc I went for something in-between, with a brief link and description of each tool in the introductory section, and a couple more links in the Resources section.

nodiscc · 2018-07-12T20:19:09Z

This is good, it's always nice to have some context.

You could do a pass of jpegoptim on the images if you think it's worth it:

$ jpegoptim *
01-create-droplet-distro.jpg 839x356 24bit N JFIF  [OK] 23677 --> 20909 bytes (11.69%), optimized.
02-create-droplet-region.jpg 994x348 24bit N JFIF  [OK] 26230 --> 21603 bytes (17.64%), optimized.
03-create-droplet-size.jpg 500x318 24bit N JFIF  [OK] 22666 --> 20860 bytes (7.97%), optimized.
04-finalize.jpg 997x348 24bit N JFIF  [OK] 32830 --> 28233 bytes (14.00%), optimized.
05-droplet.jpg 799x189 24bit N JFIF  [OK] 14516 --> 11977 bytes (17.49%), optimized.
06-domain.jpg 890x30 24bit N JFIF  [OK] 5398 --> 4499 bytes (16.65%), optimized.
07-installation.jpg 1094x647 24bit N JFIF  [OK] 50432 --> 42832 bytes (15.07%), optimized.

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam · 2018-07-12T20:51:44Z

a pass of jpegoptim

Well it doesn't hurt, done :)

ArthurHoaro · 2018-07-17T08:37:39Z

The path to the images is wrong in your guide page. They point to doc/md/images while the images are in doc/md/guides/images/.

virtualtam · 2018-07-17T09:25:55Z

Yes, MkDocs has a weird behaviour regarding file inclusion when using plain HTML instead of Markdown: mkdocs/mkdocs#991

virtualtam · 2018-07-27T17:26:14Z

Thanks @ArthurHoaro and @nodiscc for the reviews and feedback :)

virtualtam added documentation proxy hosting behind reverse proxies server docker containers & cloud labels Jun 26, 2018

virtualtam added this to the 0.10.0 milestone Jun 26, 2018

virtualtam self-assigned this Jun 26, 2018

virtualtam force-pushed the docker/compose branch 2 times, most recently from db24968 to d65144d Compare June 30, 2018 22:15

virtualtam changed the title ~~WIP: Provide a Docker Compose example~~ WIP: Provide a Docker Compose example [Nginx] Jul 1, 2018

virtualtam mentioned this pull request Jul 1, 2018

WIP: Provide a Docker Compose example [Træfik] #1170

Closed

virtualtam force-pushed the docker/compose branch from d65144d to f52a316 Compare July 1, 2018 10:18

virtualtam changed the title ~~WIP: Provide a Docker Compose example [Nginx]~~ WIP: Provide a Docker Compose example Jul 1, 2018

virtualtam force-pushed the docker/compose branch 2 times, most recently from 6807966 to 6ae39ed Compare July 1, 2018 14:06

virtualtam changed the title ~~WIP: Provide a Docker Compose example~~ Provide a Docker Compose example Jul 1, 2018

virtualtam requested review from ArthurHoaro and nodiscc July 1, 2018 14:07

virtualtam added the in review label Jul 1, 2018

virtualtam force-pushed the docker/compose branch from 6ae39ed to aafa113 Compare July 1, 2018 14:10

nodiscc added in review and removed in review labels Jul 1, 2018

virtualtam force-pushed the docker/compose branch 2 times, most recently from 5c9f4ae to a608109 Compare July 5, 2018 16:46

nodiscc reviewed Jul 7, 2018

View reviewed changes

virtualtam force-pushed the docker/compose branch from a608109 to d0f7bbf Compare July 8, 2018 22:23

Docs: rename 'How-to' section to 'Guides'

1cafacf

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam force-pushed the docker/compose branch from d0f7bbf to 8ef338a Compare July 12, 2018 20:09

Docs: Add an installation guide for Debian 9 + Docker

a0c34a4

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam force-pushed the docker/compose branch from 8ef338a to a0c34a4 Compare July 12, 2018 20:50

ArthurHoaro approved these changes Jul 24, 2018

View reviewed changes

virtualtam merged commit 8fdd65b into shaarli:master Jul 27, 2018

virtualtam deleted the docker/compose branch July 27, 2018 17:25

virtualtam removed the in review label Oct 12, 2018

virtualtam mentioned this pull request Oct 12, 2018

doc: fix homepage icon #1233

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide a Docker Compose example #1168

Provide a Docker Compose example #1168

virtualtam commented Jun 26, 2018 •

edited

Loading

ArthurHoaro commented Jun 30, 2018

virtualtam commented Jun 30, 2018

virtualtam commented Jul 1, 2018

virtualtam commented Jul 1, 2018

nodiscc Jul 7, 2018

nodiscc Jul 7, 2018

nodiscc Jul 7, 2018 •

edited

Loading

nodiscc Jul 8, 2018

virtualtam Jul 8, 2018

nodiscc Jul 7, 2018

nodiscc Jul 7, 2018

virtualtam Jul 8, 2018

virtualtam commented Jul 12, 2018

nodiscc commented Jul 12, 2018

virtualtam commented Jul 12, 2018

ArthurHoaro commented Jul 17, 2018

virtualtam commented Jul 17, 2018

virtualtam commented Jul 27, 2018

Provide a Docker Compose example #1168

Provide a Docker Compose example #1168

Conversation

virtualtam commented Jun 26, 2018 • edited Loading

ArthurHoaro commented Jun 30, 2018

virtualtam commented Jun 30, 2018

virtualtam commented Jul 1, 2018

virtualtam commented Jul 1, 2018

nodiscc Jul 7, 2018

Choose a reason for hiding this comment

nodiscc Jul 7, 2018

Choose a reason for hiding this comment

nodiscc Jul 7, 2018 • edited Loading

Choose a reason for hiding this comment

nodiscc Jul 8, 2018

Choose a reason for hiding this comment

virtualtam Jul 8, 2018

Choose a reason for hiding this comment

nodiscc Jul 7, 2018

Choose a reason for hiding this comment

nodiscc Jul 7, 2018

Choose a reason for hiding this comment

virtualtam Jul 8, 2018

Choose a reason for hiding this comment

virtualtam commented Jul 12, 2018

nodiscc commented Jul 12, 2018

virtualtam commented Jul 12, 2018

ArthurHoaro commented Jul 17, 2018

virtualtam commented Jul 17, 2018

virtualtam commented Jul 27, 2018

virtualtam commented Jun 26, 2018 •

edited

Loading

nodiscc Jul 7, 2018 •

edited

Loading