Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/convergencelabs/convergence-omnibus-container
The Omnibus (All-In-One) container distribution of Convergence
https://github.com/convergencelabs/convergence-omnibus-container
Last synced: 5 days ago
JSON representation
The Omnibus (All-In-One) container distribution of Convergence
- Host: GitHub
- URL: https://github.com/convergencelabs/convergence-omnibus-container
- Owner: convergencelabs
- License: gpl-3.0
- Created: 2020-01-09T01:59:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-25T02:14:34.000Z (over 3 years ago)
- Last Synced: 2024-08-01T12:21:36.933Z (3 months ago)
- Language: Dockerfile
- Size: 77.1 KB
- Stars: 4
- Watchers: 5
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - convergencelabs/convergence-omnibus-container - The Omnibus (All-In-One) container distribution of Convergence (others)
README
# Convergence Omnibus Container
[](https://github.com/convergencelabs/convergence-omnibus-container/actions/workflows/build.yml)
The Convergence Omnibus Container is an all-in-one version of [Convergence](https://convergence.io) which is useful for developers to use when developing Convergence based applications. It is also useful for simple, or small installations that do not require high availability.
It contains the Convergence Server, the Convergence Admin Console, the Convergence Client, and an OrientDB Database.
For documentation, code samples, and information on Convergence Enterprise Edition (suitable for production use cases), please visit: [https://convergence.io](https://convergence.io)
## Basic Usage
To run, simply execute the following docker run command:
```shell script
docker run -p "8000:80" convergencelabs/convergence-omnibus
```
### URLS
Once started several services will be available under `http://localhost:8000/` (replace port and hostname as required):
- The Convergence Admin Console will be available at: `http://localhost:8000/`.
- The REST API will be available at: `http://localhost:8000/rest/`.
- The Realtime API will be available at: `http://localhost:8000/realtime/`.
- The JavaScript API Documentation will be available at `http://localhost:8000/api/`.
- The various client builds will available at `http://localhost:8000/client/`.
### Default Credentials
A default Server Admin user will be created when the container first starts up. The default credentials are `admin` / `password`. These credentials can be changed via environment variables as shown below.
## Environment Variables
The following environment variables can be used to configure the Convergence server. All environment variables are option, and reasonable defaults are supplied.
- **`CONVERGENCE_ADMIN_USERNAME`**: Configures the username of the default server admin user that will be created upon startup.
- **`CONVERGENCE_ADMIN_PASSWORD`**: Configures the password of the default server admin user that will be created upon startup.
- **`CONVERGENCE_ADMIN_EMAIL`**: Configures the email of the default server admin user that will be created upon startup.
- **`CONVERGENCE_ADMIN_DISPLAY_NAME`**: Configures the display name of the default server admin user that will be created upon startup.
- **`CONVERGENCE_DEFAULT_NAMESPACE`**: Configures the default namespace for the server. Defaults to "convergence".
- **`CONVERGENCE_DEFAULT_DOMAIN_ID`**: Configures the id of the default domain that will be created. Defaults to `default`.
- **`CONVERGENCE_DEFAULT_DOMAIN_DISPLAY_NAME`**: Configures the display name of the default domain that will be created. Defaults to `Default`.
- **`EXTERNAL_REMOTING_PORT`**: Configures the port that Akka remoting is reachable on outside of the container. Useful if behind a proxy. Defaults to `25520`.
- **`EXTERNAL_REMOTING_HOSTNAME`**: Configures the hostname that Akka remoting is reachable on outside of the container. Useful if behind a proxy. Defaults to `localhost`.
- **`HTTP_PORT`**: Configures the HTTP port the built-in NGINX server will listen on. Defaults to `80`.
## Common Docker options
To run in detached mode (in a separate process): `-d`
Give the container a name: `--name convergence` This allows commands like `docker logs -f convergence`
## Persistent Data
Convergence stores data in an OrientDB instance that runs inside the container. A Docker volume is defined at `/orientdb/databases` to persist the data. You can create a named or host mapped volume there if you wish to persist the data outside of the container. For examle:
```shell
docker run \
-p "8000:80" \
-v ${PWD}/databases:/orientdb/databases \
convergencelabs/convergence-omnibus
```
## Support
[Convergence Labs](https://convergencelabs.com) provides several different channels for support:
- Please use the [Discourse Forum](https://forum.convergence.io) for general and technical questions, so the whole community can benefit.
- For paid dedicated support or custom development services, [contact us](https://convergence.io/contact-sales/) directly.
- Chat with us on the [Convergence Public Slack](https://slack.convergence.io).
- Email for all other inquiries.
## License
The Convergence Omnibus Container is licensed under the [GNU Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html) (GPLv3) license. Refer to the [LICENSE](https://www.gnu.org/licenses/gpl-3.0.en.html) for the specific terms and conditions of the license.
The Convergence Omnibus Container is also available under a Commercial License. If you are interested in a non-open source license please contact us at [Convergence Labs](https://convergencelabs.com).