From 26e596555cf6d2f2d405ecd042e8e69dd75e2332 Mon Sep 17 00:00:00 2001 From: l3d00m Date: Sat, 14 Sep 2024 21:10:21 +0200 Subject: [PATCH] MIGRATION notice --- README.md | 50 +------------------------------------------------- 1 file changed, 1 insertion(+), 49 deletions(-) diff --git a/README.md b/README.md index b18f52d..227af52 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,3 @@ # REIMS2 Ansible role -[![deploy](https://github.com/reims2/reims2-ansible-playbook/actions/workflows/deploy.yml/badge.svg?event=push)](https://github.com/reims2/reims2-ansible-playbook/actions/workflows/deploy.yml) -[![ansible-lint](https://github.com/reims2/reims2-ansible-playbook/actions/workflows/lint.yml/badge.svg?event=push)](https://github.com/reims2/reims2-ansible-playbook/actions/workflows/lint.yml) - -> Ansible is an IT automation tool. It can configure systems and deploy software. - -For deploying a complete instance of REIMS2, do the following **on your local dev machine**: - -0. [Install ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) -1. Install ansible dependencies with `ansible-galaxy install -r requirements.yml` -2. Add your server to the existing `hosts` file -3. Add config variables to `main.yml` (see below) -4. Create a file `creds/pub_keys` containing your SSH public keys (password based SSH login will be disabled!) -5. If you want to restore a database dump, set the `db_dump` variable to include it. It's recommend to use the `dump.example.sql` file in this repo. - -Run setup script for hardening first (strongly recommended): - -```bash -ansible-playbook -i hosts setup.yml -``` - -Now deploy REIMS2 with: - -```bash -# vaulti-id can be removed if not using ansible-vault -ansible-playbook -i hosts main.yml --vault-id -``` - -**That's it, REIMS should be up and running!** - -## Initial setup - -If you use the example `dump.sql`, the initial username is `test` and password `testtest`. It's recommended to create a new admin user, login as that and delete this initial user. - -A grafana monitoring solution will be available at `monitoring.`. Don't forget to configure it with a password. You must create a user in the database with name `monitoring` and password like the variable `monitoring_db_password`. It should have the privileges `SELECT on *.*, PROCESS, REPLICATION CLIENT`. - -## Important role variables - -These are the most important variables to set in `main.yml`: - -| Variable | Description | Default | -| ------------------------- | ---------------------------------------------------------------------------------------------------- | ------------ | -| `backend_jwt_token` | JWT token for backend authentication | REQUIRED | -| `reims2_db_password` | Password for REIMS2 database user | REQUIRED | -| `reims2_db_root_password` | Password for REIMS2 database root user | REQUIRED | -| `aws_key_id` | AWS key ID for S3 backups | REQUIRED | -| `aws_secret_key` | AWS secret key for S3 backups | REQUIRED | -| `stack_name` | Internal name for the REIMS stack. Must be unique and can't contain special characters | REQUIRED | -| `app_domain` | Domain name for REIMS2 | `reims2.app` | -| `reset_docker_stack` | Docker stack configuration will be fully reset to fix any hickups. Usually not recommended for prod. | `false` | +[MIGRATED to monorepo](https://github.com/reims2/reims2/tree/main/ansible)