Setup your In-House Fuuz Environment

Article Type: Configuration / How-To
Audience: End Users
Module: Fuuz Platform

1. Overview

What is Fuuz In-House? It is essentially the same software that is used in the cloud but accessible for on-prem/localized deployments. Some licensed features are excluded from the In-House deployments and are only accessible from the Cloud version. Additionally some of the key components we use in the cloud for high availability/redundancy are also excluded as they are not supported in Docker Swarm.

2. Prerequisites

1. System Requirements
   
1. You must have admin privileges on the machine or have an IT group that can assist you
2. Docker must be installed on the target machine
   
1. We recommend Docker Desktop for its easy management if you aren't familiar with containerized environments and command lines.
3. Minimum Requirements - At this spec you will likely have issues when the App grows in size or you run multiple apps concurrently.
   
1. 8GB of Ram
   
2. Quad Core CPU
   
4. Recommended Requirements
   
1. 32GB of Ram
   
2. Octa-core CPU
   
2. A license provided by Fuuz
   

3. Steps

1. Install Docker Desktop for your operating system here
   
2. From an elevated command line execute `docker swarm init`
   
1. This will provide the ability to run docker in swam mode.
   
2. If this command isn't executed successfully you will not be able to successfully provision the template.
   
3. Install Portainer extension for Docker Desktop
   
1. From Docker Desktop navigate to the "Extensions" tab on the left panel
   
2. Search "Portainer"
   
3. Click "Install"
   
4. Once installed and running, by default this will be accessible from https://localhost:9443
   
1. By default this runs as a HTTPS server but does not have a valid cert. Follow the instructions in your browser to ignore the warnings
   
2. We recommend signing up for the Business Edition for free which provides the ability to deploy Portainer on up to 3 separate nodes (In this deployment we will only be using one)
5. Setup your username/password
   
1. Save these somewhere to ensure you don't lose access in the future.
4. Inside Portainer
   
1. Navigate to "Templates"
   
2. In the search look for "Fuuz In-House"
   
3. Fill out the required prompts
   
4. Press "Deploy"
   
1. The stack will immediately start the process of provisioning the following
   
1. Mongo Database
   
2. RabbitMQ Message Broker
   
3. Running the initial seeds to get the environment up and running
5. From this point forward to interface with the running stack you will go under the "Stacks" tab on the left side panel
   
1. By default all services run as a single container to support minimal resource use. If you have extra capacity on the hosting machine you can tinker with the number of replicas of each service. Below are the services that provide the largest benefit from scaling.
   
1. Application - Provides redundancy for the Application GraphQL API and allows requests to be distributed across pods.
   
1. Good for a high volume of writes
   
2. Orchestration Worker - Provides additional concurrent flow node executions
   
3. Transformation - Provides additional capacity for Fuuz Scripting
   
1. Scale this similar to the Orchestration Worker as additional node executions will require additional Transformation capacity
   
4. Data Change Capture - Provides more concurrent Data Change Document writes.
   
1. Scale this in accordance with the volume of Application GraphQL API requests to flush the buffered messages in Rabbit faster.
   
5. Integration - Provides higher availability for high volume external integration requests
   
1. Scale this in accordance with the number of connections/requests
   
6. Router - Provides a gateway between the frontend and the backend
   
1. Scale this in accordance with the number of requests made to the api from outside of the docker network (Frontend, External API requests)
   

4. Validation / Success Criteria

• The stack comes up and is accessible on the local domain you provide
  
• The default is "fuuz.localhost"
• Login with the information provided in the email
  
• Email used to sign up
  
• Password defaults to "Welcome1"
  
• If login was successful, you're all set!
  
• From here, we strongly recommend watching the get started videos (Link is on the home screen)
  

5. Resources

1. Getting Started
   
2. Support
   
3. Youtube

6. Troubleshooting

• My license says it's expired but I know it's valid
  
• Verify you didn't add any characters before or after the license key
  
• Copy the license key fresh from where it was provided, try to inject it again.
  
• If none of the above solve the problem, reach out to sales@fuuz.com with the following so we can troubleshoot.
  
• Send the email from the address that was used to create the license (The seed user account)
  
• The License ID (This was provided in the initial welcome email for the license)
  
• The current container image/tags (If you aren't using latest)
  
• Most of the /fuuz container images will shut down shortly after I deploy the stack but the license server stays up?
  
• This usually indicates your license has expired. Check the container logs to confirm. If you would like to extend your license, please reach out to sales@fuuz.com
• I can't reach the frontend from fuuz.localhost from another machine
  
• This local domain will only resolve within the context of the machine it's hosted on.
  
• If you would like to access this more broadly on your home network, some routers support local DNS record redirects
  
• If your router doesn't, you may consider using something like https://pi-hole.net/ to provide a local dns server for your home network where you can map any local url to the server/api on your home network.
  
• If you would like to access this from outside of your home network there are some options
  
•  Tailscale (Currently free for up to 3 users/100 devices)
• Cloudflare Tunnel (If you already have a domain on Cloudflare this is a free feature)
  

7. Revision History