SPRPCB es un desarrollo de [ArchesProject](https://www.archesproject.org/) empleando el modelo de implementación de [OpenContext](https://github.com/opencontext/arches-via-docker)
# SPRPCB para producción
# Implementación en servidor web público Arches versión 7.6.x
El propósito principal de este repositorio es desplegar el sistema SPRPCB en el servidor del Plan Moxos. Por el momento solo está disponible la versión de producción del sistema SPRPCB migrado de la implementación de la nube de ENTEL.
## 1. Prerrequisitos
* Tener un nombre de dominio.
* Servidor con una dirección IP pública.
* Apuntar el dominio al servidor con un registro tipo A
* Docker y Docker Compose están instalados.
* Clonar el repositorio:
En un tiempo breve se habilitará una actualización para implementar una versión de desarrollo en la última versión de ArchesProject
## 2. Preparar la configuración para la instalación inicial
Este enfoque obtiene y renueva automáticamente los certificados TLS [Let's Encrypt](https://letsencrypt.org/) y configura HTTPS en Nginx para su dominio utilizando docker compose.
La idea es simple. Hay 3 contenedores que trabajan así:
* Nginx, generates self-signed "dummy" certificates to pass ACME challenge for obtaining Let's Encrypt certificates
* Certbot - for obtaining and renewing certificates, waits for Nginx to become ready and obtains certificates
* Cron - for triggering certificates renewal once a day, triggers Certbot to try to renew certificates and Nginx to reload configuration on a daily basis
* The Nginx container uses updates symbolic links that point to either "dummy" certificates or Let's Encrypt certificates.
# Personalización 1: Agregar webapp adicional
Utilizando la función proxy_pass de la aplicación de nginx, se agrega servidores adicionales para complementar el proyecto con aplicaciones web (dominios) adicionales. Por el momento el procedimiento implica personalizar los archivos complementarios del docker compose y ejecutar un comando, luego de que el sistema está funcionando. Secuencia del procedimiento:
* Crear el archivo de configuración `[docker_compose_dir]/nginx/webapp1.conf`
docker compose run --rm --no-TTY --entrypoint /tmp/nvo_dominio.sh
```
# The directories and files
The following lists some information about the contents of this repo and how they fit together:
* `docker-compose.yml`
* `.env` - specifies `COMPOSE_PROJECT_NAME` to make container names independent from the base directory name. specifies project configuration, e.g. domain names, emails, database connection details, etc. This file contains sensitive information.
* `arches/`
* `Dockerfile`
* `arches_data` - A directory on your host machine that gets attached to the Arches container. This makes it convenient to pass data (like packages or exports) in and out of your Arches container.
* `conf.d/` - A directory of Supervisord configurations for the celery worker and celery beat processes. This gets copied into the Arches container.
* `celery.py` - Editable file if you want to modify your Arches project use of celery
* `arches_proj-supervisor.conf` - Supervisord configurations for the celery worker and celery beat processes
* `entrypoint.sh` - entrypoint script. This has some handy utility functions for some routine administration of the Arches container.
* `settings_local.py` - Editable python file to define project specific settings for your Arches instance. Many of the environment variables that you assign in your `.env` file
* `settings_local.py` - Editable python file configuring URLs in your Arches instance
* `certbot/`
* `Dockerfile`
* `certbot.sh` - entrypoint script
* `cron/`
* `Dockerfile`
* `renew_certs.sh` - script executed on a daily basis to try to renew certificates
* `html/` - directory mounted as `root` for Nginx
* `index.html`
* `nginx/`
* `Dockerfile`
* `nginx.sh` - entrypoint script. This script will update where symbolic links will resolve (either to the dummy self-assigned certificates or to the Let's Encrypt obtained certificates)
* `hsts.conf` - HTTP Strict Transport Security (HSTS) policy
* `options-ssl-nginx.conf` - SSL related configurations
* `default.conf` - Nginx configuration for your domain. Contains a configuration to get A+ rating at [SSL Server Test](https://www.ssllabs.com/ssltest/). This configuration also asks Nginx to gzip compress certain text-based static files (especially CSS and Javascript) which should help with performance. This config uses symbolic links to specify the path to SSL certificates.
* `default.conf` - Nginx server configuration. It loads the Perl language module to simplify passing environment variables to your Nginx domain configuration.
* `webpack/`
* `Dockerfile`
* `webpack_entrypoint.sh` - The `webpack` container is a minimalist container that invokes a docker command on the `arches` container. This command prepares static assets for the Arches frontend by running webpack and collectstatic.
To adapt the example to your domain names you need to change only `.env`:
* `DOMAINS` - a space separated list of domains to manage certificates for
* `CERTBOT_EMAILS` - a space separated list of email for corresponding domains. If not specified, certificates will be obtained with `--register-unsafely-without-email`
* `CERTBOT_TEST_CERT` - use Let's Encrypt staging server (`--test-cert`)
Let's Encrypt has rate limits. So, while testing it's better to use staging server by setting `CERTBOT_TEST_CERT=1` (default value).
When you are ready to use production Let's Encrypt server, set `CERTBOT_TEST_CERT=0`.
## Prerequisites
1. [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed.
2. You have a domain name
3. You have a server with a publicly routable IP address
This approach will setup the most current stable version of Arches (now v7.6.x). If you want to deploy Arches version 6 (specifically stable version 6.2), please switch to the `v6` branch of this repo, with:
```bash
git checkout origin/v6
```
## Step 0 - Point your domain to server with DNS A records
For all domain names configure DNS A records to point to a server where Docker containers will be running.
## Step 1 - Edit domain names, emails and other variables in the configuration
Specify you domain names and contact emails for these domains in the `edit_dot_env` file and then save this file as `.env`:
First make an `.env` file
```bash
cp edit_dot_env .env
```
Now edit `.env` file to change your settings.
```bash
nano .env
```
Here are properties to change based on your specific Web domain. Please note, for now this only supports one domain specified by the `DOMAINS` variable (the plural is asperational..).
```properties
DOMAINS=teach-with-arches.org
CERTBOT_EMAILS=info@teach-with-arches.org
```
### Note: Non-Standard Port (8004, not 8000)
Below are properties to edit to change how Arches deploy. If you want to deploy this on your own machine (localhost), setting `DJANGO_DEBUG=True` is useful to see and diagnose useful error messages in the Arches Django application, but be sure to set `DJANGO_DEBUG=False` for deployments on the public Web. *NOTE* if you run this on your localhost, this Docker build will currently make your Arches application available to your browser via [http://127.0.0.1:8004/](http://127.0.0.1:8004/) *on port 8004*, not the usual 8000. This nonstandard port was chosen in case your local host has other applications already running on port 8000.
```properties
DJANGO_MODE=DEV
DJANGO_DEBUG=False
...
BUILD_PRODUCTION=False
```
## Step 2 - Create named Docker volumes for dummy and Let's Encrypt TLS certificates
```bash
# crear volúmenes de docker para el manejo de certificados SSL/TLS
docker volume create --name=logs_nginx
docker volume create --name=nginx_ssl
docker volume create --name=certbot_certs
docker volume create --name=arches_certbot
# Configuración de docker
cd ./avd-prod
cp edit_dot_env .env
# Personalizar el archivo .env
vi .env # o nano .env
```
## Step 3 - Use Valid Let's Encrypt Certificates
Configure to use production Let's Encrypt server in `.env`:
## 3. Configuración básica de .env
```properties
COMPOSE_PROJECT_NAME=sprpcb_prod
DOMAINS=sprpcb.patrimonio.org.bo
CERTBOT_EMAILS=sysadmin@patrimonio.org.bo
CERTBOT_TEST_CERT=0
```
## Step 4 - Build images and start containers
## 4. Construir imágenes, arrancar y detener contenedores
```bash
docker compose up --build
```
## Config Changes? - Replace volumes etc to implement changes
Stop the containers:
Detener y eliminar los contenedores:
```bash
docker compose down
```
Re-create the volume for Let's Encrypt certificates:
Arrancar y detener (Start, Stop) los contenedores:
```bash
docker volume rm certbot_certs
docker volume rm arches_certbot
docker volume create --name=certbot_certs
docker volume create --name=arches_certbot
docker compose start
docker compose stop
```
Start the containers:
## Cómo crear comandos de administración de Arches
Además de configurar HTTPS y Nginx, este repositorio implementa una instancia de Arches.
Al inicio, se configura una instancia de Arches "vacía". Se deberá cargar con datos propios mediante la instalación de un paquete o algún otro método.
Una vez implementada Arches, puedes usar los comandos de administración habituales de Arches desde el servidor. Por ejemplo:
## How to Make Arches (administrative) Management Commands
Besides setting up HTTPS and Nginx, this repo deploys an instance of Arches. Currently this will setup an "empty" Arches instance. You'll need to load it with your own data by loading a package or some other approach. Once you deploy Arches, you can use normal Arches management commands as so:
You may run into weirdness permissions issues restarting the docker container. I solved it with:
```
sudo chmod 666 /var/run/docker.sock
```
# BACKGROUND AND CREDIT
This repo will hopefully streamline deployment of Arches for use on the Web. Eventually, we hope to use this as the basis for deploying instances of Arches for use in archaeological teaching and learning applications.
None of this code is very original. This repo started by forking:
SPRPCB es un desarrollo de [ArchesProject](https://www.archesproject.org/) y para este proyecto, se emplea el modelo de implementación de [OpenContext](https://github.com/opencontext/arches-via-docker)
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
