Skip to content

Commit

Permalink
Merge pull request #4259 from FlowFuse/move-local-installation
Browse files Browse the repository at this point in the history
move local installation under contribute section
  • Loading branch information
knolleary committed Jul 26, 2024
2 parents 47c6de7 + 166daad commit 3baa362
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 37 deletions.
2 changes: 1 addition & 1 deletion docs/admin/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ to create and edit the stacks on the platform.
For Deployment specific information about working with stacks, refer to the
documentation of your chosen deployment model:

- [Local Stacks](/docs/install/local/stacks.md)
- [Local Stacks](/docs/contribute/local/stacks.md)
- [Docker Stacks](/docs/install/docker/stacks.md)
- [Kubernetes Stacks](/docs/install/kubernetes/stacks.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ navTitle: Local Install

# Local Install

This version of the FlowFuse platform is intended for running on a single machine
for a smaller deployment (e.g. evaluation or home user).


This guide is for setting up FlowFuse on a single machine, ideal for smaller deployments, evaluations, or for contributors who want to gain a basic understanding of the FlowFuse platform and its features.

**Note: Local installation does not support HTTPS**

Expand Down Expand Up @@ -132,7 +129,7 @@ If you want to allow access from other devices on the network, you must edit the
change the `host` setting to `0.0.0.0` and change `base_url` to contain the IP address of the server.

NOTE: We do not support changing the `host` and `base_url` values once you have created an instance.
For more information on all of the options available, see the [configuration guide](../configuration.md).
For more information on all of the options available, see the [configuration guide](/docs/install/configuration.md).


## Running FlowFuse
Expand Down Expand Up @@ -160,7 +157,7 @@ Or to run as a service:

Once FlowFuse is started, you will be ready to perform the first run setup.

Follow [this guide](../first-run.md) to continue.
Follow [this guide](/docs/install/first-run.md) to continue.

## Setting up Mosquitto (optional)

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/install/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
navTitle: Docker install\
navTitle: Docker install
meta:
description: Learn how to install FlowFuse using Docker Compose for on-premise deployments. Configure DNS, manage Node-RED instances, and set up HTTPS with Let's Encrypt or wildcard TLS certificates
---
Expand Down
36 changes: 9 additions & 27 deletions docs/install/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ navOrder: 1
---
# Installing FlowFuse

FlowFuse can be installed on most Linux distributions, Windows, and MacOS.
FlowFuse can be installed to run in Docker or Kubernetes based environments.

It provides three models for how to run and manage the individual Node-RED instances
it creates. Choosing the right model is important based on how you plan to use
the platform.
- [Docker Install Guide](/docs/install/docker/README.md)
- [Kubernetes Install Guide](/docs/install/kubernetes/README.md)

We also provide one-click installs of the Docker version:

- [Digital Ocean Docker Install Guide](/docs/install/docker/digital-ocean.md)
- [AWS Docker Install Guide](/docs/install/docker/aws-marketplace.md)

## Request a Trial Enterprise License

Expand Down Expand Up @@ -66,28 +70,6 @@ hbspt.forms.create({
});
</script>
## One-Click Docker Installer
<a href="https://marketplace.digitalocean.com/apps/flowforge"><img src="https://upload.wikimedia.org/wikipedia/commons/f/ff/DigitalOcean_logo.svg" width="150" height="75"></a>
See also the [Digital Ocean Step by Step Manual](/docs/install/docker/digital-ocean.md)
<br>
<a href="https://aws.amazon.com/marketplace/pp/prodview-3ycrknfg67rug?sr=0-1&ref_=beagle&applicationId=AWSMPContessa"><img src="https://upload.wikimedia.org/wikipedia/commons/9/93/Amazon_Web_Services_Logo.svg" width="150" height="75"></a>
See also the [AWS Step by Step Manual](/docs/install/docker/aws-marketplace.md)
## Deployment Models
Model | Description
-----------|--------------------
[Local](/docs/install/local/README.md) | Runs the Node-RED instances on the same machine running the core FlowFuse application. The instances are exposed on different TCP ports. This is intended for smaller deployments, such as for evaluation, or personal use.
[Docker](/docs/install/docker/README.md) | Run the platform in a Docker Compose based environment.
[Kubernetes](/docs/install/kubernetes/README.md) | Run the platform in a full Kubernetes based environment.
If you are just getting started with FlowFuse and want to evaluate what it can do,
we recommend starting with the [Local model](/docs/install/local/README.md).
## Upgrading FlowFuse
If you are upgrading FlowFuse, please refer to the [Upgrade Guide](/docs/upgrade/README.md)
Expand All @@ -104,4 +86,4 @@ If you need assistance, request our complimentary Installation Service, and we w
portalId: "26586079",
formId: "22edc659-d098-4767-aeb1-6480daae41ad"
});
</script>
</script>
4 changes: 2 additions & 2 deletions docs/upgrade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ has been performed.

Details of how to upgrade can be found for each deployment model:

- [LocalFS](../install/local/README.md#upgrade)
- [LocalFS](../contribute/local/README.md#upgrade)
- [Docker](../install/docker/README.md#upgrade)
- [Kubernetes](../install/kubernetes/README.md#upgrade)

Expand Down Expand Up @@ -137,7 +137,7 @@ This release introduces an MQTT Broker into the FlowFuse platform used to commun
between devices and the core platform.

For LocalFS users, they will need to manually setup the broker and ensure it is
properly configured. The documentation for this is available [here](../install/local/#setting-up-mosquitto-(optional))
properly configured. The documentation for this is available [here](../contribute/local#setting-up-mosquitto-(optional))

#### LocalFS Users

Expand Down

0 comments on commit 3baa362

Please sign in to comment.