Skip to content

Commit fb49a7c

Browse files
nicolas-albertyosifkit
nicolas-albert
authored and
yosifkit
committed
Added Convertigo images documentation. (docker-library#820)
* Created Convertigo docs folder
1 parent 1c76538 commit fb49a7c

File tree

5 files changed

+101
-0
lines changed

5 files changed

+101
-0
lines changed

‎convertigo/README-short.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Convertigo is an open source MBaaS/MADP platform for mobile application development and back-end.

‎convertigo/content.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# What is Convertigo Mobility Platform ?
2+
3+
Convertigo Community edition is an open source MBaaS (Mobile Back end as a Service) combined with a MADP (Mobile application development platform). The platform is used to build complex Cross-platform Enterprise Mobile apps in a few days. Convertigo platform is composed of several components:
4+
5+
1. **Convertigo**: The back-end MBaaS server part. Runs as a Docker container with **convertigo** image
6+
2. **Convertigo Web Connector**: An optional HTML web Connector server able to connect to any HTML based legacy app. Runs as a Docker container with a **web-connector** tag
7+
3. **Convertigo Studio**: Runs on a Windows or a MacOS workstation, Eclipse based IDE, used to program MBaaS workflows and to build Mobile apps UIs. Can be directly downloaded from [Sourceforge.net](https://sourceforge.net/projects/convertigo/files/latest/download)
8+
4. **Convertigo SDKs**: Can be used with third party Mobile development tools such as Xcode (iOS) Android Studio (Android) and Visual Studio (Windows Mobile, Windows UWP and Xamarin). SDKS are available on each platform standard repository (Bintray for Android, Cocoapods for iOS and Nuget for .NET)
9+
10+
Convertigo Community edition brought to you by Convertigo SA (Paris & San Francisco). The platform is currently used by more than 100K developers worldwide, building enterprise class mobile apps.
11+
12+
> [www.convertigo.com](https://www.convertigo.com)
13+
14+
%%LOGO%%
15+
16+
# How to use this image
17+
18+
## Quick start
19+
20+
$ docker run --name C8O -d -p 28080:28080 convertigo
21+
22+
This will start a container running the minimum Convertigo MBaaS server. Convertigo MBaaS uses images' **/workspace** directory to store configuration file and deployed projects as an Docker volume.
23+
24+
You can access the Server admin console on http://[dockerhost]:28080/convertigo and login using the default credentials: admin / admin
25+
26+
## Link Convertigo to a CouchDB database for FullSync (Convertigo EE only)
27+
28+
Convertigo MBaaS FullSync module uses Apache CouchDB 1.6.1 as NoSQL repository. You can use the **[couchdb](https://hub.docker.com/_/couchdb/)** docker image and link to it convertigo this way
29+
30+
Launch CouchDB container and name it 'fullsync'
31+
32+
docker run -d --name fullsync couchdb:1.6.1
33+
34+
Then launch Convertigo and link it to the running 'fullsync' container. Convertigo MBaaS sever will automatically use it as its fullsync repository.
35+
36+
docker run -d --name C8O-MBAAS --link fullsync:couchdb -p 28080:28080 convertigo
37+
38+
## Link Convertigo to a Billing & Analytics database
39+
40+
### MySQL
41+
42+
MySQL is the recommended database for holding Convertigo MBaaS server analytics. You can use this command to run convertigo and link it to a running MySQL container. Change `[mysql-container]` to the container name, and `[username for the c8oAnalytics db]`, `[password for specified db user]` with the values for your MySQL configuration.
43+
44+
docker run -d --name C8O-MBAAS --link [mysql-container]:mysql -p 28080:28080 \
45+
-e JAVA_OPTS="-Dconvertigo.engine.billing.enabled=true \
46+
-Dconvertigo.engine.billing.persistence.jdbc.username=[username for the c8oAnalytics db] \
47+
-Dconvertigo.engine.billing.persistence.jdbc.password=[password for specified db user] \
48+
-Dconvertigo.engine.billing.persistence.jdbc.url=jdbc:mysql://mysql:3306/c8oAnalytics" \
49+
convertigo
50+
51+
## Where is Convertigo MBaaS server storing deployed projects
52+
53+
Projects are deployed in the Convertigo workspace, a simple file system directory. You can map the docker container **/workspace** to your physical system by using :
54+
55+
docker run --name C8O-MBAAS -v $(pwd):/workspace -d -p 28080:28080 convertigo
56+
57+
You can share the same workspace by all Convertigo containers. This this case, when you deploy a project on a Convertigo container, it will be seen by others. This is the best way to build multi-instance load balanced Convertigo server farms.
58+
59+
## Migrate from an earlier version of Convertigo
60+
61+
- Stop the container to perform a backup. And just back the workspace directory. This will backup all the projects definitions and some project data.
62+
- Start a new Convertigo MBaaS docker container mapping the workspace
63+
- All the workspace (Projects) will be automatically migrated to the new Convertigo MBaaS version
64+
65+
## Security
66+
67+
The default administration account of a Convertigo serveur is **admin** / **admin** and the **testplatform** is anonymous.
68+
69+
These accounts can be configured through the *administration console* and saved in the **workspace**.
70+
71+
### `CONVERTIGO_ADMIN_USER` and `CONVERTIGO_ADMIN_PASSWORD` variables
72+
73+
You can change the default administration account :
74+
75+
docker run -d --name C8O-MBAAS -e CONVERTIGO_ADMIN_USER=administrator -e CONVERTIGO_ADMIN_PASSWORD=s3cret -p 28080:28080 convertigo
76+
77+
### `CONVERTIGO_TESTPLATFORM_USER` and `CONVERTIGO_TESTPLATFORM_PASSWORD` variables
78+
79+
You can lock the **testplatform** by setting the account :
80+
81+
docker run -d --name C8O-MBAAS -e CONVERTIGO_TESTPLATFORM_USER=tp_user -e CONVERTIGO_TESTPLATFORM_PASSWORD=s3cret -p 28080:28080 convertigo
82+
83+
## `JAVA_OPTS` Environment variable
84+
85+
Convertigo is based on a *Java* process with some defaults *JVM* options. You can override our defaults *JVM* options with you own.
86+
87+
Add any *Java JVM* options such as -Xmx or -D[something]
88+
89+
docker run -d --name C8O-MBAAS -e JAVA_OPTS="-Xmx4096 -DjvmRoute=server1" -p 28080:28080 convertigo
90+
91+
## Pre configurated Docker compose stack
92+
93+
You can use this [stack](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo MBaaS server with FullSync repository and MySQL analytics in a few command lines.
94+
95+
mkdir c8oMBaaS
96+
cd c8oMBaaS
97+
wget https://raw.githubusercontent.com/convertigo/docker/master/compose/mbaas/docker-compose.yml
98+
docker-compose up -d

‎convertigo/github-repo

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/convertigo/docker

‎convertigo/license.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Convertigo Community Edition MBaaS image is licenced under [AGPL 3.0](http://www.gnu.org/licenses/agpl-3.0.html)

‎convertigo/logo.png

9.47 KB
Loading

0 commit comments

Comments
 (0)