Skip to content

Commit b9510ba

Browse files
skadefroskadefro
committed
test docs
1 parent 522d72f commit b9510ba

5 files changed

Lines changed: 92 additions & 24 deletions

File tree

‎docs/README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,10 @@
22

33
OpenFlow is basically a couple of [NodeRED](https://nodered.org/) installation and an API on top of a [MongoDB](https://www.mongodb.com/) instance, using [RabbitMQ](https://www.rabbitmq.com/) for scalability. It is designed to supplement digitalization strategies by giving an easy to use, highly scalable and secure platform that supports human workflows, automation of IT systems and things (Internet of things or classical production systems like SCADA/PLC). IT also functions as the dashboard and enabler of enterprise functionality of [OpenRPA](https://github.com/open-rpa/openrpa)
44

5-
Creating your first [user form](forms)
5+
Installing using [docker-compose](dockercompose)
66

7+
Working with [versioning](versioning)
8+
9+
Creating your first [user form](forms_old) using the old form designer
10+
11+
Using the [mobile app](mobileapp)

‎docs/dockercompose.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Docker Compose
2+
3+
To quickly get started with your own installation you can use one of these docker-compose files.
4+
download the file you want ( you can rename the file to docker-compose.yaml or use -f to specify the file )
5+
6+
[docker-compose-traefik.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose-traefik.yml) is for people running docker ce/docker desktop or docker swarm
7+
8+
[docker-compose-toolbox.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose-toolbox.yml) is for people running [docker toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)
9+
10+
[docker-compose.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose.yml) is for developers who don't want to install [mongoDB](https://www.mongodb.com/download-center/community)/[RabbitMQ](https://www.rabbitmq.com/download.html) or an easy way to run one instance while debugging the other.
11+
12+
open a shell and cd to that folder you downloaded the file to, and type
13+
14+
```bash
15+
docker-compose up
16+
```
17+
18+
Say you downloaded docker-compose-traefik.yml and you want to set your own project name.
19+
20+
```bash
21+
docker-compose -f docker-compose-traefik.yml -p demo up
22+
```
23+
24+
This will be the basis for everything else you do, for instance, if you need to update the images to the latest version, you would then use
25+
26+
```bash
27+
docker-compose -f docker-compose-traefik.yml -p demo pull
28+
```
29+
30+
Then you can access the API/web on [http://localhost.openiap.io](http://localhost.openiap.io) ( or [http://toolbox.openiap.io](http://toolbox.openiap.io) )
31+
You can access nodered on [http://nodered1.localhost.openiap.io](http://nodered1.localhost.openiap.io) ( or [http://nodered1.toolbox.openiap.io](http://nodered1.toolbox.openiap.io) )
32+
and RabbitMQ on [http://mq.localhost.openiap.io](http://mq.localhost.openiap.io) ( or [http://mq.toolbox.openiap.io](http://mq.toolbox.openiap.io) )
33+
34+
The first username and password you try to login as, will be created and made admin. This **cannot** be admin, root or other common administrate account names.
35+
36+
For almost everyone, you will want to start with docker-compose-traefik.yml
37+
This gives you a good starting point for testing it on your local machine, and play around with the settings. Once you understand how it works, and you know how to change the domain names it responds too, then you can push this to a server locally or to some cloud provider. If you have a public IP for the solution you can also have a look at docker-compose-traefik-letsencrypt.yml for a guide on how to use Lets Encrypt for certificates.
38+
For more complex setups where you don't have public IP or just need access to wildcard certificates there is also an example on how to request Lets Encrypt certificates using DNS01 in the docker-compose-traefik-letsencrypt-dns01.yml file.
39+
40+
For questions or help, feel free to join the community on the [forum](https://bb.openiap.io) or [rocket chat](https://rocket.openiap.io).
41+
42+
For help with running on [kubernetes](kubernetes) or self hosting, feel free to contact [OpenIAP](https://openiap.io/) for a commercial support options.

docs/forms.md renamed to docs/forms_old.md

File renamed without changes.

‎docs/kubernetes.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Kubernetes
2+
3+
OpenFlow was designed to run on [kubernetes](https://kubernetes.io). You can still deployed in other ways, but for most production setups, that is the recommend platform to run it on, at least for the primary site.
4+
5+
We use helm to deploy different deployments to kubernetes, so first install [helm](https://github.com/helm/helm/releases) simply drop this some where and add it to the path, so you can reference it from cmd/powershell. Also, make sure you have [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured to access your kubernetes cluster.
6+
7+
OpenFlow depends on [traefik](https://doc.traefik.io/traefik/v1.7/user-guide/kubernetes/) as ingress controller. It's beyond the scope of this guide on how to install this in non-clouded envoriments, but if you are using GKE, aWS, Azure, Alibaba or some of the other cloud providers that has out of the box external loadbalencers, you can simpy deploy trafik with the service with type: LoadBalancer, and from here on everything "just works".
8+
9+
You can find an example on how to deploy traefik using help on [this page](https://github.com/open-rpa/helm-charts/tree/main/traefik-example)
10+
I also go though this process in the video
11+
[![Configuring Openflow on Kubernetes](https://img.youtube.com/vi/onI_9JIAKbM/1.jpg)](https://youtu.be/onI_9JIAKbM)
12+
13+
So first we need to add OpenIAP's helm repo and update this and other repos you might have installed
14+
15+
```bash
16+
helm repo add openiap https://open-rpa.github.io/helm-charts/
17+
helm repo update
18+
```
19+
20+
Next create a values file. To avoid confusen i recomend you name this file the same as your namespace and the "instance" you are creating. So imaging you want to deploy an openflow instance responding to demo.mydomain.com then create a file names demo.yaml
21+
22+
There is a ton of different settings you can fine tune, you can always find all the settings in the openflow [values file here](https://github.com/open-rpa/helm-charts/blob/main/charts/openflow/values.yaml) but you only need to add the values you want to override, so get you started this would be a good starting point to add to your demo.yaml file
23+
24+
```yaml
25+
# this will be the root domain name hence your openflow url will now be http://demo.mydomain.com
26+
domainsuffix: mydomain.com # this will be added to all domain names
27+
domain: demo
28+
# if using a reverse procy that add ssl, uncomment below line.
29+
# protocol: https
30+
openflow:
31+
# external_mongodb_url: mongodb+srv://user:pass@cluster0.gcp.mongodb.net?retryWrites=true&w=majority
32+
rabbitmq:
33+
default_pass: supersecret
34+
# if you are using mpongodb atlas, or has mongodb running somewhere else
35+
# uncomment below line, and external_mongodb_url in openflow above
36+
# mongodb:
37+
# enabled: false
38+
```
39+
40+
41+

‎readme.md‎

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -165,31 +165,11 @@ then open a browser and visit [localhost.openiap.io:1880](http://localhost.openi
165165

166166
#### Quick start using docker
167167

168-
To quickly get started with your own installation you can use one of these docker-compose files.
169-
download the file you want
170-
rename to docker-compose.yaml
171-
open a shell and cd to that folder you downloaded the file to, and type
172-
docker-compose up
173-
or
174-
docker-compose up -d
168+
Installing using [docker-compose](docs/dockercompose)
175169

176-
[docker-compose-traefik.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose-traefik.yml) is for people running docker ce/docker desktop or docker swarm
170+
#### Quick start using kubernetes
177171

178-
[docker-compose-toolbox.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose-toolbox.yml) is for people running [docker toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)
179-
180-
[docker-compose.yml](https://github.com/open-rpa/openflow/blob/master/docker-compose.yml) is for developers who don't want to install [mongoDB](https://www.mongodb.com/download-center/community)/[RabbitMQ](https://www.rabbitmq.com/download.html) or an easy way to run one instance while debugging the other.
181-
182-
Then you can access the API/web on [http://localhost.openiap.io](http://localhost.openiap.io) ( or [http://toolbox.openiap.io](http://toolbox.openiap.io) )
183-
You can access nodered on [http://nodered1.localhost.openiap.io](http://nodered1.localhost.openiap.io) ( or [http://nodered1.toolbox.openiap.io](http://nodered1.toolbox.openiap.io) )
184-
and RabbitMQ on [http://mq.localhost.openiap.io](http://mq.localhost.openiap.io) ( or [http://mq.toolbox.openiap.io](http://mq.toolbox.openiap.io) )
185-
186-
The first username and password you try to login as, will be created and made admin
187-
188-
For help with running on [kubernetes](https://kubernetes.io/) or self hosting contact [OpenIAP](https://openiap.io/) for a support agreement
189-
190-
#### Quick start using helm to install on kubernetes
191-
192-
To quickly get started with your own installation on kubernetes, first install [traefik](https://doc.traefik.io/traefik/v1.7/user-guide/kubernetes/)
172+
Installing using [docker-compose](docs/kubernetes)
193173

194174
Each OpenFlow will have it's own namespace, and you create a value file for each instance/namespace
195175
Create a file and call it demo1.yaml with this content

0 commit comments

Comments
 (0)