Skip to content

Clarify the differences between the Installer and Capistrano #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
taitus merged 2 commits into from
Apr 29, 2026
Merged

Clarify the differences between the Installer and Capistrano #231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
536f50e
Mention configuration variables before the playbook
Senen Nov 15, 2023
1fe60fc
Clarify Installer vs Capistrano responsibilities and re-running Ansible
Senen Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

[CONSUL DEMOCRACY](https://github.com/consuldemocracy/consuldemocracy) installer for production environments

The Consul Democracy installer's objective is to help the community provision a brand-new server with all the libraries and tools needed to run Consul Democracy on production. We do not recommend using the installer on servers already running other services.

You can re-run the playbook for infrastructure changes the installer supports (such as HTTPS with Let's Encrypt or adjustments in `group_vars/all`) as in the SSL section below.

Once you've got a working Consul Democracy installation, you should *not* use this installer to upgrade to a new version of Consul Democracy. That's not supported, and you might end up losing data. To upgrade to a new version of Consul Democracy, follow the instructions in the release notes for that version, and deploy the new version to the server with Capistrano. Check the [keep your fork updated documentation](https://docs.consuldemocracy.org/tech_docs/getting_started/update#pulling-changes-from-consul-democracy) for more information.

Using [Ansible](http://docs.ansible.com/), it will install and configure the following:

- Ruby
Expand All @@ -21,7 +27,7 @@ It will also create a `deploy` user to install these libraries

[How to setup CONSUL DEMOCRACY for a production environment](https://youtu.be/1lvnjDuRFzw)

## Prerequisities
## Prerequisites

A remote server with one of the supported distributions:

Expand Down Expand Up @@ -71,6 +77,8 @@ Update your local `hosts` file with the remote server's ip address
remote-server-ip-address (maintain other default options)
```

Before running the playbook, review the defaults in `group_vars/all` and the [configuration variables](#configuration-variables) in this README.

Run the ansible playbook

```
Expand Down