Create `install.sh` script #119

davidbeig · 2025-10-16T08:34:17Z

This PR closes #113 .

We are adding a script that enables the creation of a Decidim instance based on the docker images built in this repository. The user will be guided through some questions on how to properly configure the instance, and the script itself will take care of the necessary dependencies (such as the database, where the storage is going to be located, etc).

Some improvements:

Checksum every file.
This will generate extra-security on the download of the shell script and the files it uses, giving the final user more security.
Add health capabilities to the containers.

What we still need

We need a way to deliver releases of the install script. Currently there's a github action to create a .zip file that the script is going to download in the server and build from there all the infrastructure.

How to test

Using the released zip.

sudo curl -s https://raw.githubusercontent.com/decidim/docker/refs/heads/feat/decidim_install/install/install.sh | bash

While developing we might not have access to the released zip, the way to test it is to zip ourselfs the script folder and push it to the server.

cd install
zip -r deploy.zip *
scp deploy.zip user@ip:/tmp/decidim-docker/install

Later on, we need the deploy.zip to be under the /tmp/decidim-docker-files/deploy.zip. It's a bit messy right now.

Also, if you want to try it locally you can use multipass

cd install
zip -r deploy.zip 
cd ..
multipass launch --name decidim-docker --cpus 2 --memory 4G --disk 20G
multipass mount . decidim-docker:/home/ubuntu/decidim-docker
multipass shell decidim-docker
cd decidim-docker
bash install/install.sh

scripts/install.sh

andreslucena · 2025-12-11T10:34:50Z

@davidbeig can you check the qlty check blocking issues: https://qlty.sh/gh/decidim/projects/docker/pull/119/issues

As we've talked, @microstudi will do the first round and @greenwoodt will check out the English messages and tone.

Afterwards we'll check this out as @decidim/maintainers

microstudi

I found one pain point when configuring the SMTP

Asked values are not explained, we should explain every parameter as most people won't undersand the meaning of each var:

so, instead of "SMTP_USERNAME", maybe somthing like:

SMTP Username (this is usually the email used to send emails)

Speacially confusing the difference between SMPT_ADRESS and SMTP_DOMAIN, we should explain the difference between these two!

I found another problem at the end of the script:

Vagrantfile

install/install.sh

README.md

davidbeig · 2025-12-16T14:22:35Z

I found one pain point when configuring the SMTP

Asked values are not explained, we should explain every parameter as most people won't undersand the meaning of each var:

so, instead of "SMTP_USERNAME", maybe somthing like:
SMTP Username (this is usually the email used to send emails)
Speacially confusing the difference between SMPT_ADRESS and SMTP_DOMAIN, we should explain the difference between these two!

I found another problem at the end of the script:

The last part of the script you see comes from the log of the application running.

It's, in fact, expected. It comes from this:
docker compose logs --tail=30

Since there are gems to install, the bundle check fails and then executes the bundle install.

I'm changing the wording in that part of the script to be explicit about this.

greenwoodt

Some standard but very minor changes to wording of script language communicating to the implementer during the installation. Also adding consistency to what you've already done.

Take a long and let me know what you think @davidbeig :)

All in all really beautifully described!

greenwoodt · 2026-01-08T10:48:22Z

install/install.sh

+echo -e "*   • SMTP server settings for emails                                 *"
+echo -e "*   • File storage settings (local or S3)                             *"
+echo -e "*                                                                     *"
+echo -e "* 💡 All dependencies (Docker, etc.) will be installed for you        *"


Suggested change

echo -e "* 💡 All dependencies (Docker, etc.) will be installed for you *"

echo -e "* 💡 All dependencies (Docker, etc) will be installed for you. *"

greenwoodt · 2026-01-08T10:52:52Z

install/install.sh

+  mkdir "$TMP"
+fi
+
+echo "📥 Downloading the installation necessary files."


Suggested change

echo "📥 Downloading the installation necessary files."

echo "📥 Downloading the necessary installation files."

greenwoodt · 2026-01-08T10:58:46Z

install/up.sh

+# Check if .env file exists
+if [ ! -f "$ENV_FILE" ]; then
+  echo "❌ Error: .env file not found at $ENV_FILE"
+  echo "   Please run the installation script first or create the .env file manually."


Suggested change

echo " Please run the installation script first or create the .env file manually."

echo "Please run the installation script first or create the .env file manually."

greenwoodt · 2026-01-08T11:00:02Z

install/up.sh

+
+docker compose --env-file "$ENV_FILE" up -d
+
+echo "📋 Showing recent container logs..."


Suggested change

echo "📋 Showing recent container logs..."

echo "📋 Displaying recent container logs..."

greenwoodt · 2026-01-08T11:02:11Z

install/install.sh

+echo "🐛 Issues: https://github.com/decidim/decidim/issues"
+echo "🐛 Installation Issues: https://github.com/decidim/docker/issues"
+echo
+echo "Have fun using Decidim! 🗳️"


Suggested change

echo "Have fun using Decidim! 🗳️"

echo "Enjoy using Decidim! 🗳️"

Its definitely sincere, however to avoid interpreting what "could" be translated as condescending.

greenwoodt · 2026-01-08T11:33:36Z

install/dependencies/build_env.sh

+build_external_database() {
+  echo "📋 External Database Configuration"
+  echo "   Please provide your external database details:"
+  echo "   💡 Make sure your database server allows connections from this machine"


Suggested change

echo " 💡 Make sure your database server allows connections from this machine"

echo " 💡 Make sure your database server allows connections from this machine."

greenwoodt · 2026-01-08T11:34:57Z

install/dependencies/build_env.sh

+MAPS_API_PROVIDER=${MAPS_API_PROIVDER=-here}
+
+echo "───────────────────────────────────────────────"
+echo "Now we are going to create the .env file."


Suggested change

echo "Now we are going to create the .env file."

echo "✍️ Now we are going to create the .env file."

greenwoodt · 2026-01-08T11:36:21Z

install/dependencies/generate_vapid_keys.sh

+export VAPID_PUBLIC_KEY
+export VAPID_PRIVATE_KEY
+
+echo "🔑 Keys successfully extracted"


Suggested change

echo "🔑 Keys successfully extracted"

echo "🔑 Keys successfully extracted!"

greenwoodt · 2026-01-08T11:36:57Z

install/dependencies/os_version.sh

+  exit 1
+fi
+
+echo "Correct distribution."


Suggested change

echo "Correct distribution."

echo "✅ Correct distribution."

greenwoodt · 2026-01-08T11:37:24Z

install/scripts/entrypoint.sh

+if [ -z "$SKIP_MIGRATIONS" ]; then
+  bundle exec rails db:migrate
+else
+  echo "⚠️ Skipping migrations"


Suggested change

echo "⚠️ Skipping migrations"

echo "⚠️ Skipping migrations!"

davidbeig added 3 commits October 16, 2025 10:19

add vagrant to test script

2f7a103

add compose files

f0d9789

add initial scripts

8940ca0

davidbeig self-assigned this Oct 16, 2025

generate SECRET_KEY_BASE

fc2ca20

microstudi reviewed Oct 16, 2025

View reviewed changes

scripts/install.sh Outdated Show resolved Hide resolved

davidbeig mentioned this pull request Oct 16, 2025

Production Wokflow Issues #120

Open

davidbeig and others added 23 commits October 21, 2025 15:32

add memory to Vagrant

51f9238

add traefik domain and fix default decidim_image

38fc814

add pull_policy always to worker

32e3f9b

add storage to handle volume in app if not bucket

e9d262e

change how to handle repository path

5181c5f

add migration execution on app entrypoint

fe067ac

fix up script to handle local database and local storage

1e9a000

change local database to generate user, password and database name

e0b7bd5

add script to generate gemfiles

ca858ad

add alpine versions for cache and db

f2955bd

generate vapid keys

32009ec

make docker script exit after installing

97c3ffb

pull decidim image when deciding version

acc8327

git clone repository to repository path

4035540

fix on decidim version script

e550ea6

change docker installation process

be2ca79

fix on variable assignment

174af9e

fix use of variable

434d6ba

add volumes for Gemfile.wrapper and Gemfile.local

4917f61

read from /dev/tty

a47284b

check before deleting .env file

c0168d1

ask before openning ports

1773cf8

fix parameters passed to docker compose

03553cd

davidbeig added 3 commits December 11, 2025 09:54

add sidekiq config

2100eb9

add some readme documentation

f828cdb

shell linting

9a4fc1d

davidbeig marked this pull request as ready for review December 11, 2025 08:58

microstudi requested changes Dec 15, 2025

View reviewed changes

Vagrantfile Outdated Show resolved Hide resolved

install/install.sh Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

remove vagrantfile

553c013

davidbeig added 21 commits December 16, 2025 15:38

improve messages to choose decidim version

a65ab0b

add more context to vapid and export vars

5ec5764

change check of decidim running to create system admin

712467f

Improve messages and flow of docker installation

6750e1c

change messages of up.sh

dccb70b

add new messages and bash fixes

26ebc1f

refactor and add maps envs

e581b92

remove env var

b23a5ad

shellcheck fixes

5344a7b

shellcheck 1091

d83e3c9

disable sc1091

3931590

fixes on certs and health_check

96ac72f

update release zip url

7aa5159

improve and fix zip download

5fa1536

force overrite of extracted files

75b462c

add minor improvements

94513a0

remove pull_policy

4a665e0

open ports by default

9e7b7b8

remove option to change decidim version, only install latest

4e8a722

automatically create system password

fc3ed3a

fix generate system

02ac09f

greenwoodt reviewed Jan 8, 2026

View reviewed changes

	echo -e "* 💡 All dependencies (Docker, etc.) will be installed for you *"
	echo -e "* 💡 All dependencies (Docker, etc) will be installed for you. *"

	echo "📥 Downloading the installation necessary files."
	echo "📥 Downloading the necessary installation files."

	echo " Please run the installation script first or create the .env file manually."
	echo "Please run the installation script first or create the .env file manually."


		docker compose --env-file "$ENV_FILE" up -d

		echo "📋 Showing recent container logs..."

	echo "📋 Showing recent container logs..."
	echo "📋 Displaying recent container logs..."

	echo "Have fun using Decidim! 🗳️"
	echo "Enjoy using Decidim! 🗳️"

	echo " 💡 Make sure your database server allows connections from this machine"
	echo " 💡 Make sure your database server allows connections from this machine."

	echo "Now we are going to create the .env file."
	echo "✍️ Now we are going to create the .env file."

	echo "🔑 Keys successfully extracted"
	echo "🔑 Keys successfully extracted!"

	echo "Correct distribution."
	echo "✅ Correct distribution."

	echo "⚠️ Skipping migrations"
	echo "⚠️ Skipping migrations!"

Create install.sh script #119

Are you sure you want to change the base?

Create install.sh script #119

Uh oh!

Conversation

davidbeig commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

andreslucena commented Dec 11, 2025

Uh oh!

microstudi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidbeig commented Dec 16, 2025

Uh oh!

greenwoodt left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Create `install.sh` script #119

Create `install.sh` script #119

davidbeig commented Oct 16, 2025 •

edited

Loading

greenwoodt left a comment •

edited

Loading