Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/damalis/full-stack-apache2-rails-for-everyone-with-docker-compose

If You want to build a website with Rails at short time; install full stack apache2 Rails with Docker Compose. Plus, manage docker containers with Portainer, and even secure your site with SSL.
https://github.com/damalis/full-stack-apache2-rails-for-everyone-with-docker-compose

framework full-stack-framework full-stack-web-development mvc rails rails-api rails-application rails-developer ruby ruby-application ruby-on-rails web-application webapp webapplication website websockets

Last synced: about 2 months ago
JSON representation

If You want to build a website with Rails at short time; install full stack apache2 Rails with Docker Compose. Plus, manage docker containers with Portainer, and even secure your site with SSL.

Awesome Lists containing this project

README 

          
# [full stack apache2 Rails for everyone with docker compose](https://github.com/damalis/full-stack-apache2-rails-for-everyone-with-docker-compose)



If You want to build a website with Rails at short time; 



#### Full stack Apache2 Rails:



 Rails     

 docker     

 mariadb     

 mysql     

 apache2     

 redis     

 Bash     

 phpmyadmin     

 certbot     

 letsencrypt    

 portainer     

 backup 




Plus, manage docker containers with Portainer.



#### Supported CPU architectures:

 arm64/aarch64, x86-64 



#### Supported Linux Package Manage Systems:

 apk, dnf, yum, apt/apt-get/dpkg, zypper, pacman 



#### Supported Linux Distributions:

 centos, debian, fedora, raspbian, rhel, sles, static, ubuntu 


 

#### Supported Linux Operation Systems:



 alpine linux     

 fedora     

 centos     

 debian     

 ubuntu     

 ubuntu     

 redhat on s390x (IBM Z)     

 opensuse on s390x (IBM Z)     

 arch linux 




##### Note: Fedora 37, 39 and alpine linux x86-64 compatible, could not try sles IBM Z s390x, rhel IBM Z s390x and raspberrypi.

##### After installing the repository, a system reboot is required on Red Hat OS, Arch Linux.



#### With this project you can quickly run the following:



- [Rails](https://github.com/rails)

- [webserver (apache2/httpd)](https://hub.docker.com/_/httpd)

- [certbot (letsencrypt)](https://hub.docker.com/r/certbot/certbot)

- [phpMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/)

- [Mariadb](https://hub.docker.com/_/mariadb) [Mysql](https://hub.docker.com/_/mysql)

- [redis](https://hub.docker.com/_/redis)

- [backup](https://hub.docker.com/r/offen/docker-volume-backup)



#### For certbot (letsencrypt) certificate:



- [Set DNS configuration of your domain name](https://support.google.com/a/answer/48090?hl=en)



#### IPv4/IPv6 Firewall

Create rules to open ports to the internet, or to a specific IPv4 address or range.



- http: 80

- https: 443

- portainer: 9001

- phpmyadmin: 9090



#### Contents:



- [Auto Configuration and Installation](#automatic)

- [Manual Configuration and Installation](#manual)

	- [Requirements](#requirements)

	- [Configuration](#configuration)

	- [Installation](#installation)

- [Portainer Installation](#portainer)

- [Usage](#usage)

	- [Website](#website)

	- [Webserver](#webserver)

	- [Database](#database)

	- [Redis](#redis)

	- [phpMyAdmin](#phpmyadmin)

	- [backup](#backup)



### Automatic



#### Exec install shell script for auto installation and configuration



download with



```

git clone https://github.com/damalis/full-stack-apache2-rails-for-everyone-with-docker-compose.git

```



Open a terminal and `cd` to the folder in which `docker-compose.yml` is saved and run:



```

cd full-stack-apache2-rails-for-everyone-with-docker-compose

chmod +x install.sh

LC_ALL=C.UTF-8 ./install.sh # LC_ALL=C.UTF-8 if not os language english

```



### Manual



#### Requirements



Make sure you have the latest versions of **Docker** and **Docker Compose** installed on your machine and require up to 2 GB of RAM.



- [How install docker](https://docs.docker.com/engine/install/)

- [How install docker compose](https://docs.docker.com/compose/install/)



Clone this repository or copy the files from this repository into a new folder.



Make sure to [add your user to the `docker` group](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user).



#### Configuration



download with



```

git clone https://github.com/damalis/full-stack-apache2-rails-for-everyone-with-docker-compose.git

```



Open a terminal and `cd` to the folder in which `docker-compose.yml` is saved and run:



```

cd full-stack-apache2-rails-for-everyone-with-docker-compose

```



Copy the example environment into `.env`



```

cp env.example .env

```



Edit the `.env` file to change values of



|```LOCAL_TIMEZONE```|```DOMAIN_NAME```|```DIRECTORY_PATH```|```LETSENCRYPT_EMAIL```|

|```DB_USER```|```DB_PASSWORD```|```DB_NAME```|```MYSQL_ROOT_PASSWORD```|```DATABASE_IMAGE_NAME```|

|```DATABASE_CONT_NAME```|```DATABASE_PACKAGE_MANAGER```|```DATABASE_ADMIN_COMMANDLINE```|```PMA_CONTROLUSER```|```PMA_CONTROLPASS```|

|```PMA_HTPASSWD_USERNAME```|```PMA_HTPASSWD_PASSWORD```|```SSL_SNIPPET```|



  

    Variable 

    Value

  



  

    LOCAL_TIMEZONE

    to see local timezones

  

  

    DIRECTORY_PATH

    pwd at command line

  

  

    DATABASE_IMAGE_NAME

    mariadb or mysql

  

  

    DATABASE_CONT_NAME

    mariadb, mysql or custom name

  

  

    DATABASE_PACKAGE_MANAGER

    mariadb

    apt-get update && apt-get install -y gettext-base

  

  

    mysql

    microdnf update -y && microdnf install -y gettext

  

  

    DATABASE_ADMIN_COMMANDLINE

    mariadb

    mariadb-admin

  

  

    mysql

    mysqladmin

  

  

    SSL_SNIPPET

    localhost

    echo 'Generated Self-signed SSL Certificate at localhost'

  

  

    remotehost

    certbot certonly --webroot --webroot-path /tmp/acme-challenge --rsa-key-size 4096 --non-interactive --agree-tos --no-eff-email --force-renewal --email ${LETSENCRYPT_EMAIL} -d ${DOMAIN_NAME} -d www.${DOMAIN_NAME}

  



#### Installation



Firstly: will create external volume



```

docker volume create --driver local --opt type=none --opt device=${PWD}/certbot --opt o=bind certbot-etc

```



Localhost ssl: Generate Self-signed SSL Certificate with guide [mkcert repository](https://github.com/FiloSottile/mkcert).



```

docker compose up -d

```



then reloading for webserver ssl configuration



```

docker container restart webserver

```



The containers are now built and running. You should be able to access the Rails installation with the configured IP in the browser address. `https://DOMAIN_NAME`.



For convenience you may add a new entry into your hosts file.



### Portainer



```

docker compose -f portainer-docker-compose.yml -p portainer up -d 

```



manage docker with [Portainer](https://www.portainer.io/) is the definitive container management tool for Docker, Docker Swarm with it's highly intuitive GUI and API. 



You can also visit `https://DOMAIN_NAME:9001` to access portainer after starting the containers.



### Usage



#### You could manage docker containers without command line with portainer.



#### Here’s a quick reference of commonly used Docker Compose commands



```

docker ps -a # Lists all containers managed by the compose file

```



```

docker compose start # Starts previously stopped containers

```



```

docker compose stop # Stops all running containers

```



```

docker compose down # Stops and removes containers, networks, etc.

```



```

docker compose down -v # Add --volumes to remove volumes explicitly

```



```

docker rm -f $(docker ps -a -q) # Removes portainer and the other containers

```



```

docker volume rm $(docker volume ls -q) # Removes all volumes

```



```

docker network prune # Remove all unused networks

```



```

docker system prune # Removes unused data (containers, networks, images, and optionally volumes)

```



```

docker system prune -a # Removes all unused images, not just dangling ones

```



```

docker rmi $(docker image ls -q) # Removes portainer and the other images

```



```

docker container logs container_name_or_id # Shows logs from all services

```



#### Project from existing source



Copy all files into a new directory:



```

docker compose up -d # Starts services in detached mode (in the background)

```



#### Docker run reference



[https://docs.docker.com/reference/cli/docker/compose/](https://docs.docker.com/reference/cli/docker/compose/)



#### Website



You should see the "Rails version: ... and Ruby version: ..." page in your browser. If not, please check if your installation satisfies Rails's requirements.



Blocked hosts: must add the contents of ```./rails/config/environments/development.rb``` with the following:



```config.hosts << "DOMAIN_NAME"``` then ```docker container restart rails```



```

https://DOMAIN_NAME

```



add and/or remove rails site folders and files with any ftp client program in ```./rails``` folder.


You can also visit `https://DOMAIN_NAME` to access website after starting the containers.



#### Webserver



add or remove code in the ```./webserver/extra/httpd-ssl.conf``` file for custom apache2/httpd configurations



[https://httpd.apache.org/docs/2.4/](https://httpd.apache.org/docs/2.4/)



#### Database



Replace the contents of ```./rails/config/database.yml``` with the following:



```

default: &default

  adapter: mysql2

  host: database

  username: {DB_USER}

  password: {DB_PASSWORD}

  pool: 5



development:

  <<: *default

  database: {DB_NAME}



test:

  <<: *default

  database: myapp_test

```



then ```docker container restart rails```



[https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application](https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application)



[https://mariadb.com/kb/en/configuring-mariadb-with-option-files/](https://mariadb.com/kb/en/configuring-mariadb-with-option-files/)



[https://dev.mysql.com/doc/](https://dev.mysql.com/doc/)



#### Redis



add the configuration in the relevant ```./rails/config/environments/development.rb``` file:



```config.cache_store = :redis_cache_store, { url: 'redis' }```



then ```docker container restart rails```



[https://guides.rubyonrails.org/caching_with_rails.html#activesupport-cache-rediscachestore](https://guides.rubyonrails.org/caching_with_rails.html#activesupport-cache-rediscachestore)



#### phpMyAdmin



You can add your own custom config.inc.php settings (such as Configuration Storage setup) by creating a file named config.user.inc.php with the various user defined settings in it, and then linking it into the container using:



```

./phpmyadmin/config.user.inc.php

```



You can also visit `https://DOMAIN_NAME:9090` to access phpMyAdmin after starting the containers.



The first authorize screen(htpasswd;username or password) and phpmyadmin login screen the username and the password is the same as supplied in the `.env` file.



#### backup



This will back up the all files and folders in database/dump sql and html volumes, once per day, and write it to ```./backups``` with a filename like backup-2023-01-01T10-18-00.tar.gz



##### can run on a custom cron schedule



```BACKUP_CRON_EXPRESSION: '20 01 * * *'``` the UTC timezone.