Carbonio Workstream Collaboration DB 🚀

Service sidecar used by Zextras Carbonio Workstream Collaboration to communicate with a centralized database

---

How to Build 🔧

To build artifacts locally, run the build-artifacts.sh script. You'll need docker installed locally.

How to install 🏁

Preparing the environment

• Install PostgreSQL: apt install postgresql

• Create a postgres superuser:

  # sudo -u postgres psql
  # CREATE ROLE "carbonio_adm" WITH LOGIN SUPERUSER encrypted password
  'your-secret-password';
  # \q

Installation

Install carbonio-ws-collaboration-db via apt:

sudo apt install carbonio-ws-collaboration-db

or via yum:

sudo yum install carbonio-ws-collaboration-db

Configuration

In order to make it work with external databases the carbonio-ws-collaboration-db.hcl MUST be manually updated by changing the address from 127.0.0.1 to the remote address. To finalize the configuration:

• Execute pending-setups in order to register the service in the service-discover

• Bootstrap the Workstream Collaboration database:

  PGPASSWORD=your-secret-password carbonio-ws-collaboration-db-bootstrap
  carbonio_adm 127.0.0.1

If the bootstrap script is executed multiple times it reuses the credentials created the first time and stored in service-discover.

Reading config values

All the necessary configurations are saved automatically in the service-discover configuration system. They can be retrieved with the following commands:

• consul kv get -token-file="/etc/carbonio/ws-collaboration/service-discover /token" "carbonio-ws-collaboration-db/db-name"
• consul kv get -token-file="/etc/carbonio/ws-collaboration/service-discover /token" "carbonio-ws-collaboration-db/db-username"
• consul kv get -token-file="/etc/carbonio/ws-collaboration/service-discover /token" "carbonio-ws-collaboration-db/db-password"

---

License 📚

Copyright (C) 2023 Zextras https://www.zextras.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 only of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see Licenses - GNU Project - Free Software Foundation

See COPYING file for the project license details

Copyright and Licensing notices

All non-software material (such as, for example, names, images, logos, sounds) is owned by Zextras s.r.l. and is licensed under CC-BY-NC-SA (https://creativecommons.org/licenses/by-nc-sa/4.0/). Where not specified, all source files owned by Zextras s.r.l. are licensed under AGPL-3.0-only.