Skip to content

Commit

Permalink
Merge pull request #1608 from flowforge/backport-1604
Browse files Browse the repository at this point in the history
First pass at Digital Ocean Droplet doc (backport #1604)
  • Loading branch information
hardillb committed Jan 24, 2023
2 parents fe6a1bb + a2c55f7 commit ddbbb88
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/install/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ This version of the FlowForge platform is intended for running in the Docker Con

The following instructions assume you are running Docker on a Linux or MacOS host system.

If you are using Digital Ocean Docker Droplet to host FlowForge you will need to ensure that port 80 & 443 are opened in the UFW firewall before starting.
#### Digital Ocean

If you are using the Digital Ocean Docker Droplet to host FlowForge you will need to ensure that port 80 & 443 are opened in the UFW firewall before starting.

```bash
sudo ufw apply http
sudo ufw apply https
```

We have a 1-Click Digital Ocean Droplet that will install and configure FlowForge for you. Details can be found [here](./digital-ocean.md)

### Docker Compose

FlowForge uses Docker Compose to install and manage the required components. Instructions on how to install Docker Compose on your system can be found here:
Expand Down
52 changes: 52 additions & 0 deletions docs/install/docker/digital-ocean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 1-Click Digital Ocean Droplet Install

We have packaged the Docker Compose build of FlowForge as a Digital Ocean Droplet. It can be found in the Digital Ocean Market Place [here](https://marketplace.digitalocean.com/apps/flowforge?refcode=fb23e438a477)

You can just straight to the deployment wizard [here](https://marketplace.digitalocean.com/apps/flowforge?refcode=fb23e438a477&action=deploy)

## Prerequisites

### DNS

To make use of this Droplet you will need a DNS Domain to host both the FlowForge application and the Projects you create.

For example if you use `ff.example.com` then the FlowForge application will run on `https://forge.ff.example.com` and a project would be on `https://[project-name].ff.example.com`.

You will need to set up a wildcard DNS entry that points the whole domain to the Public IP address of the Droplet.

```
*.ff.example.com 3600 A xxx.xxx.xxx.xxx
```

The Public IP address of the Droplet will be listed in the UI when it has been created

![Digital Ocean Droplet IP address ](../images/do-public-ip.png)

## Setup

After the Droplet has been created and you have set up the DNS entry you will need to connect to the droplet to and enter the domain name

You can do this in 2 ways

1. With SSH, either using keys or password depending on what Authentication mechanism you picked at creation time
```
ssh -i digtial-ocean-ssh.key root@xxx.xxx.xxx.xxx
```
2. Opening a Console from the Web Interface
![Digital Ocean Console](../images/do-droplet-console.png)

Once logged in you will be presented with a wizard to set the domain and confirm by entering `1` or `2` to enter the domain again.

![Digial Ocean Wizard](../images/do-wizard.png)

The wizard will then update the configuration files and start FlowForge

![Digial Ocean Direct to Setsup](../images/do-direct-to-setup.png)

It will then present a link to complete setup in the browser. You can now close the console connection to the droplet.

Details of how to complete this steps are [here](../first-run.md)

## Upgrade

You can follow the normal FlowForge Docker [upgrade instructions](./README.md#upgrade), the install directory is `/opt/flowforge`
Binary file added docs/install/images/do-direct-to-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/install/images/do-droplet-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/install/images/do-public-ip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/install/images/do-wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/user/project-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Project Settings are split into a number of sections:
## Environment

This allows you to manage the project's environment variables. More information
on working with environment variables is available [here](./envvar).
on working with environment variables is available [here](./envvar.md).

## Editor

Expand Down

0 comments on commit ddbbb88

Please sign in to comment.