|
1 | | -# cubeSQL Web Admin |
2 | | -A web based administration for [cubeSQL Server](https://sqlabs.com/cubesql) (© [sqlabs](https://sqlabs.com/)) |
| 1 | +# cubeSQL Web Admin |
| 2 | +A web based administration for [cubeSQL Server](https://sqlabs.com/cubesql) (© [sqlabs](https://sqlabs.com/)) |
3 | 3 |
|
4 | | -[](LICENSE) |
| 4 | +[](LICENSE) |
5 | 5 |
|
6 | 6 | ## Description |
7 | 7 |
|
8 | | -*[cubeSQL Server](https://sqlabs.com/cubesql) is a fully featured and high performance relational database management system built on top of the sqlite database engine.* |
| 8 | +*[cubeSQL Server](https://sqlabs.com/cubesql) is a fully featured and high performance relational database management system built on top of the sqlite database engine.* |
9 | 9 |
|
10 | | -cubeSQL Web Admin is a web based administration tool for [cubeSQL Server](https://sqlabs.com/cubesql). |
| 10 | +cubeSQL Web Admin is a web based administration tool for [cubeSQL Server](https://sqlabs.com/cubesql). |
11 | 11 |
|
12 | | - |
| 12 | + |
13 | 13 |
|
14 | | - |
| 14 | + |
15 | 15 |
|
16 | 16 | ## Build from Source Code |
17 | 17 |
|
18 | | -In order to build cubeSQL Web Admin application, [Xojo](https://xojo.com/) and the latest [cubeSQL Xojo Plugin](https://github.com/cubesql/cubeSQLAdmin) are required. |
| 18 | +In order to build cubeSQL Web Admin application, [Xojo](https://xojo.com/) and the latest [cubeSQL Xojo Plugin](https://github.com/marcobambini/cubesqlplugin) are required. |
19 | 19 |
|
20 | | -- Xojo can be obtained from: https://xojo.com/ |
21 | | -- Latest [cubeSQL Xojo Plugin](https://github.com/cubesql/cubeSQLAdmin) can be found inside the Plugins folder |
| 20 | +- Xojo can be obtained from: [https://xojo.com/](https://xojo.com/) |
| 21 | +- Latest [cubeSQL Xojo Plugin](https://github.com/marcobambini/cubesqlplugin) can be downloaded from the [Releases](https://github.com/marcobambini/cubesqlplugin/releases) |
22 | 22 |
|
23 | 23 | ## Ready to use executables and Docker Images |
24 | 24 |
|
25 | 25 | 1. Executables are provided with the [Releases](https://github.com/cubesql/webadmin/releases). |
26 | 26 | - A Shell Script is provided to choose a Port and launch the Web Application |
27 | 27 | - It is up to you to install the Web Application as a service. |
28 | | - See [Xojo Documentation: Deployment Overview](https://documentation.xojo.com/topics/application_deployment/web/deployment_overview.html) |
| 28 | + See [Xojo Documentation: Deployment Overview](https://documentation.xojo.com/topics/application_deployment/web/deployment_overview.html) |
29 | 29 |
|
30 | 30 | 2. Docker Images provided by jo-tools can be found here: |
31 | | - [Docker Hub: jotools/cubesql-webadmin](https://hub.docker.com/r/jotools/cubesql-webadmin) |
| 31 | + [Docker Hub: jotools/cubesql-webadmin](https://hub.docker.com/r/jotools/cubesql-webadmin) |
32 | 32 |
|
33 | 33 | 3. Docker Compose setups provided by jo-tools can be found here: |
34 | 34 | [GitHub: jo-tools/docker](https://github.com/jo-tools/docker) |
35 | 35 | - These setups contain both cubeSQL Server and cubeSQL Web Admin |
36 | 36 |
|
37 | 37 | ## Configuration |
38 | 38 |
|
39 | | -cubeSQL Web Admin supports the following launch arguments and corresponding environment variables: |
| 39 | +cubeSQL Web Admin supports the following launch arguments and corresponding environment variables. |
40 | 40 |
|
41 | | -#### Web Application |
| 41 | +*Example:* |
| 42 | +*Launch cubeSQLWebAdmin on Port 8080 and prefill login data to connect to a cubeSQL Server running on localhost Port 4440:* |
| 43 | + `/path/to/launch/cubeSQLWebAdmin --Port=8080 --CubeSQLHostname=localhost --CubeSQLPort=4440 --CubeSQLUsername=admin --CubeSQLPassword=admin` |
| 44 | + |
| 45 | +### Web Application |
42 | 46 | - `--Port` | `CUBESQL_WEBADMIN_PORT` |
43 | 47 |
|
44 | | -#### Prefill Login data: |
| 48 | +### Default New Connection |
45 | 49 |
|
46 | 50 | - `--CubeSQLHostname` | `CUBESQL_HOSTNAME` |
47 | 51 | - `--CubeSQLPort` | `CUBESQL_PORT` |
48 | 52 | - `--CubeSQLEncryption` | `CUBESQL_ENCRYPTION` with values: `NONE`, `AES128`, `AES128`, `SSL` |
49 | 53 | For Encryption type `SSL`: |
50 | 54 | - `--CubeSQLSSLCertificate` | `CUBESQL_SSL_CERTIFICATE` |
51 | | - with value: `/path/to/file` |
| 55 | + *with value:* `/path/to/file` |
52 | 56 | - `--CubeSQLSSLCertificatePassword` | `CUBESQL_SSL_CERTIFICATEPASSWORD` |
53 | | - with value: `/path/to/file.txt` | plain text |
| 57 | + *with value:* plain text | `/path/to/file.txt` | `` `/output/of/a/shell/cmd` `` |
54 | 58 | - `--CubeSQLSSLRootCertificate` | `CUBESQL_SSL_ROOTCERTIFICATE` |
55 | | - with value: `/path/to/file` |
| 59 | + *with value:* `/path/to/file` |
56 | 60 | - `--CubeSQLSSLCipherList` | `CUBESQL_SSL_CIPHERLIST` |
57 | | - with value: `/path/to/file.txt` | plain text |
| 61 | + *with value:* plain text | `/path/to/file.txt` |
58 | 62 | - `--CubeSQLUsername` | `CUBESQL_USERNAME` |
59 | 63 | Only if Username is prefilled: |
60 | | - - `--CubeSQLPassword` | `CUBESQL_PASSWORD` |
| 64 | + - `--CubeSQLPassword` | `CUBESQL_PASSWORD` |
| 65 | + *with value:* plain text | `/path/to/file.txt` | `` `/output/of/a/shell/cmd` `` |
| 66 | + |
| 67 | +### Connection Choice |
| 68 | + |
| 69 | +To offer a list of connection choices they can be specified in a JSON file which contains an array of [`ConnectionItems`](./webapp/ConnectionItem.xojo_code). |
| 70 | + |
| 71 | +*Example:* [`connection-choice.json`](./resources/connection-choice.json) |
| 72 | + |
| 73 | +- `--CubeSQLConnectionChoice` | `CUBESQL_CONNECTIONCHOICE` |
| 74 | + *with value:* `/path/to/connection-choice.json` |
61 | 75 |
|
62 | 76 |
|
63 | 77 | ## About |
64 | | -cubeSQL Web Admin has been written by Jürg Otter, who is a long term user of Xojo and working for [CM Informatik AG](https://cmiag.ch/). Their Application [CMI LehrerOffice](https://cmi-bildung.ch/) is a Xojo Design Award Winner 2018. In his leisure time Jürg provides some [bits and pieces for Xojo Developers](https://www.jo-tools.ch/). |
| 78 | +cubeSQL Web Admin has been written by Jürg Otter, who is a long term user of Xojo and working for [CM Informatik AG](https://cmiag.ch/). Their Application [CMI LehrerOffice](https://cmi-bildung.ch/) is a Xojo Design Award Winner 2018. In his leisure time Jürg provides some [bits and pieces for Xojo Developers](https://www.jo-tools.ch/). |
0 commit comments