https://github.com/zextras/carbonio-ws-collaboration-db
This repository includes the means to build the carbonio-chats-db package, which is simply a consul wrapper for whichever db will be underneath.
https://github.com/zextras/carbonio-ws-collaboration-db
carbonio-component
Last synced: 5 months ago
JSON representation
This repository includes the means to build the carbonio-chats-db package, which is simply a consul wrapper for whichever db will be underneath.
- Host: GitHub
- URL: https://github.com/zextras/carbonio-ws-collaboration-db
- Owner: zextras
- License: agpl-3.0
- Created: 2022-12-22T09:59:52.000Z (over 3 years ago)
- Default Branch: devel
- Last Pushed: 2026-01-19T12:09:23.000Z (5 months ago)
- Last Synced: 2026-01-19T18:59:25.489Z (5 months ago)
- Topics: carbonio-component
- Language: Shell
- Size: 82 KB
- Stars: 0
- Watchers: 9
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
Carbonio Workstream Collaboration DB 🚀
Service sidecar used by Zextras Carbonio Workstream Collaboration to
communicate with a centralized database
[![Contributors][contributors-badge]][contributors]
[![Activity][activity-badge]][activity]
[![License][license-badge]](COPYING)
[![Project][project-badge]][project]
[![Twitter][twitter-badge]][twitter]
***
## 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:
```bash
# 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:
```bash
sudo apt install carbonio-ws-collaboration-db
```
or via yum:
```bash
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:
```bash
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
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](https://www.gnu.org/licenses/licenses.html
"https://www.gnu.org/licenses/licenses.html")
See [COPYING](COPYING.md) 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
().
Where not specified, all source files owned by Zextras s.r.l. are licensed
under AGPL-3.0-only.
[contributors-badge]: https://img.shields.io/github/contributors/zextras/carbonio-user-management-sdk "Contributors"
[contributors]: https://github.com/zextras/carbonio-user-management-sdk/graphs/contributors "Contributors"
[activity-badge]: https://img.shields.io/github/commit-activity/m/zextras/carbonio-user-management-sdk "Activity"
[activity]: https://github.com/zextras/carbonio-user-management-sdk/pulse "Activity"
[license-badge]: https://img.shields.io/badge/license-AGPL-blue.svg
[project-badge]: https://img.shields.io/badge/project-carbonio-informational "Project Carbonio"
[project]: https://www.zextras.com/carbonio/ "Project Carbonio"
[twitter-badge]: https://img.shields.io/twitter/follow/zextras?style=social&logo=twitter "Follow on Twitter"
[twitter]: https://twitter.com/intent/follow?screen_name=zextras "Follow Zextras on Twitter"