ayapapa/docker-alminium repository overview

⁠What?

This is ALMinium's docker version. Once you install docker and docker-compose, you can use ALMinium easily with command "docker-compose up -d", and custormize easily by modifying docker-compose.yml.

(Japanese) ALMiniumのDocker版を作ってみるサイトです。 docker-composeを利用していますので、docker-compose.ymlのホスト名、ポート番号や環境変数を変更することでカスタマイズ出来ます。起動は、"docker-compose up -d"と叩くだけです。

refs:

• ALMinium: https://github.com/ayapapa/alminium⁠, which is forked from https://github.com/alminium/alminium⁠
• Dockerized ALMinium: https://github.com/ayapapa/docker-alminium⁠
• Docker image: https://hub.docker.com/r/ayapapa/docker-alminium/⁠

⁠Prerequisites

⁠install docker

for example, in the case of Ubunt16.04:

sudo apt-get update && sudo apt-get -y dist-upgrade
curl -fsSL https://get.docker.com/ | sh

see https://docs.docker.com/engine/installation/⁠
see https://get.docker.com/⁠

⁠install docker-compose

see https://docs.docker.com/compose/⁠ or https://github.com/docker/compose/releases⁠
for example:

sudo su
[sudo] password for user-name: (your password)
curl -L https://github.com/docker/compose/releases/download/1.14.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose

⁠How to start

⁠Start with docker-compose

git clone https://github.com/ayapapa/docker-alminium.git  
cd docker-alminium  
sudo docker-compose up -d  

see https://docs.docker.com/compose/⁠
You can use AMinium(Redmine + several plugins) trough web-browser with URL http://localhost:10080⁠.
And you can change the hostname and the port number(defaults to 10080) by editing docker-composer.yml and restarting.
After the sudo docker-compose up -d execution, initialization processing of several tens of seconds to several minutes is done. If the display error occurs in the browser, please wait for a while and then display again.
(Japanese)ブラウザで http://localhost:10080⁠ をアクセスするとALMiniumが表示されます。
ホスト名、ポート番号など適切な設定に変更してお使いください。
sudo docker-compose up -d 実行後に、数十秒～数分程度の初期化処理が行われます。ブラウザーで表示エラーになる場合は、しばらく待ってから、再表示してください。

⁠Jenkins initialization

After installation, when accessing Jenkins service for the first time, the initialization process starts. For initial password, use /home/jenkins/secrets/initialAdminPassword. Also, when doing authentication collaboration with ALMinium (Redmine), please activate ** Redmine plugin ** at initialization or after initialization. After that, set "Jenkins management" → "Global security setting" → "Enable security" → "Select Redmine user authentication" and set as follows.

• Redmine DBMS : MySQL
• DB Server : db
• Port : 3306
• DB name : alminium
• DB user : alminium
• DB passwoerd: alminium
• Redmine version: 1.2.0 or upper

If you need Jenkins configuration file, you can find /home/jenkins on the host PC.

(Japanese)インストール後、最初にJenkinsサービスにアクセスすると、初期化処理が開始されます。初期パスワードは、 /home/jenkins/secrets/initialAdminPassword を利用してください。 また、ALMinium(Redmine)と認証連携をする場合は、初期化時あるいは初期化後に、Redmine pluginを有効化してください。 その後、「Jenkinsの管理」→「グローバルセキュリティの設定」→「セキュリティを有効化」→「Redmineユーザー認証を選択」し、以下の通り設定してください。

• Redmine DBMS : MySQL
• DBサーバー : db
• ポート番号 : 3306
• データベース名: alminium
• DBユーザー : alminium
• DBパスワード : alminium
• Redmineバージョン: 1.2.0以上

※Jenkins設定ファイルは、/home/jenkinsに格納されています。

⁠To use behind a proxy

To use behind a proxy, please add environment variables, http_proxy and https_proxy, into docker-compose.yml.

⁠backup and restore

⁠How to backup

sudo docker exec -it dockeralminium_ALMinium_1 bash backup

⁠How to restore

sudo docker exec -it dockeralminium_ALMinium_1 bash restore # you can get backup list like following
/var/opt/alminium-backup/2021-04-05-05-12-32-alm-backup.tar.gz
...
# if you restore /var/opt/alminium-backup/2021-04-05-05-12-32-alm-backup.tar.gz, execute next command.
sudo docker exec -it dockeralminium_ALMinium_1 bash restore 2021-04-05-05-12-32-alm-backup.tar.gz

⁠How to upgrade Jenkins (an example)

sudo docker exec -it dockeralminium_jenkins_1 apt update
sudo docker exec -it dockeralminium_jenkins_1 apt list --upgradable
sudo docker exec -it dockeralminium_jenkins_1 apt dist-upgrade jenkins
sudo docker exec -it dockeralminium_jenkins_1 service jenkins restart

⁠How to upgrade Mysql (an example)

sudo docker exec -it dockeralminium_db_1 apt update
sudo docker exec -it dockeralminium_db_1 apt list --upgradable
sudo docker exec -it dockeralminium_db_1 apt dist-upgrade mysql-server
sudo docker exec -it dockeralminium_db_1 service mysql restart

⁠Environment Variables

You can configure by modifying Envitonment Variables in docker-compose.yml.

*If you like to change the certification file, you should dive into ALMinium container with command "docker exec -it (container's name) /bin/bash", and then put your certification file on the place you like, and change /etc/opt/alminium/redmine-ssl.conf's certification description.