Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/RunOnFlux/flux

Flux, Your Gateway to a Decentralized World. https://home.runonflux.io https://api.runonflux.io https://docs.runonflux.io https://source.runonflux.io https://wiki.runonflux.io
https://github.com/RunOnFlux/flux

cloud computing decentralized flux server web3

Last synced: 19 days ago
JSON representation

Flux, Your Gateway to a Decentralized World. https://home.runonflux.io https://api.runonflux.io https://docs.runonflux.io https://source.runonflux.io https://wiki.runonflux.io

Lists

README 

        
# Flux



![Flux.png](flux_banner.png)



[![DeepScan grade](https://deepscan.io/api/teams/6436/projects/8442/branches/100920/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=6436&pid=8442&bid=100920)[![CodeFactor](https://www.codefactor.io/repository/github/runonflux/flux/badge)](https://www.codefactor.io/repository/github/runonflux/flux)[![Total alerts](https://img.shields.io/lgtm/alerts/g/RunOnFlux/flux.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RunOnFlux/flux/alerts/)[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/RunOnFlux/flux.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RunOnFlux/flux/context:javascript)[![codecov](https://codecov.io/gh/RunOnFlux/flux/branch/development/graph/badge.svg?token=N31OUPUWZJ)](https://codecov.io/gh/RunOnFlux/flux)



Flux is available on domains, load balancing the entire Flux network. You can access both UI and API on following main domain



[Flux](https://home.runonflux.io)



[API](https://api.runonflux.io)



## API Documentation



[API documentation](https://docs.runonflux.io)



## Source code Documentation



[Source Code documentation](https://source.runonflux.io)



## The gateway to the Flux Network



Flux is the frontend UI to the entire Flux Network, it enables Flux operators to manage their Flux Node easily via a simple web interface. Flux enables an operator to perform all tasks such as updating and maintenance from a simple web interface, instead of having to remotely login to their Flux to manage it.



Flux Requires a reasonably new version of Node.js (npm), MongoDB and Docker. It is a MongoDB, Express.js, Vue.js, Node.js (MEVN) application



This application communicates locally with the Flux Daemon (fluxd), Benchmark Daemon (fluxbenchd) and other Flux instances.



Support for Ubuntu 18.04, 20.04, 22.04



Support NodeJS 16, 18, 20



Support for MongoDB 4.2, 4.4, 5.0, 6.0



## Application Overview



### Backend Solution - Flux



- Provide communication with daemon, benchmark

- Providing private API, and public API, Flux team API (limited!)

- Listen and handle frontend requests

- Requests signing and authenticity verifying

- Handle communication with other Fluxes

- Manage Flux applications - smart spawning, distributing workload, termination depending of application subscription.

- Provide Explorer solution

- and more!



### Frontend Solution - Home



- Display Flux status information

- Display Flux Network information

- Display Flux network information

- Display Specific application information

- Provide API access

- Login into private API part (frontend part)

- Login into Flux team API part (frontend part)

- Private: Management of Flux

- Private: Management of Flux Damone and Benchmark

- Private: Update, status information

- and more!



This application is open source and distributed under the GNU AGPLv3 licence



## Start Flux



Flux needs Daemon to be running, use apt.runonflux.io to install flux daemon



build-essential is a recommended dependency



```bash



sudo apt-get install build-essential

```



Setup Mongodb on Ubuntu 18.04 (LTS):



```bash

wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -



echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list



sudo apt-get update



sudo apt-get install -y mongodb-org



sudo service mongod start

```



Setup Mongodb on Ubuntu 20.04 (LTS):



```bash

wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -



echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list



sudo apt-get update



sudo apt-get install -y mongodb-org



sudo service mongod start

```



Setup Mongodb on Red Hat or CentOS:



```bash

sudo yum install nano



sudo nano /etc/yum.repos.d/mongodb-org-5.0.repo



# Paste below into the mongodb-org-5.0.repo file



[mongodb-org-5.0]

name=MongoDB Repository

baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/5.0/x86_64/

gpgcheck=1

enabled=1

gpgkey=https://www.mongodb.org/static/pgp/server-5.0.asc



# exit nano



sudo yum install -y mongodb-org



# Start Mongodb on startup for CentOS 7

sudo systemctl enable mongod.service



# Start Mongodb on startup for CentOS 5/6

sudo chkconfig mongod on



# Start Mongodb on CentOS 7

sudo systemctl start mongod.service



# Start Mongodb on CentOS 5/6

sudo service mongod start

```



Install Node Version Manager (NVM) and NodeJS 16/18/20 on Ubuntu 18.04/20.04/22.04:



```bash

sudo apt-get install curl



curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash



source ~/.profile



nvm install 20



nvm use 20

```



Install Node Version Manager (NVM) and NodeJS 20 on Redhat/CentOS:



```bash

sudo yum install curl



curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash



source ~/.bashrc



nvm install 20



nvm use 20

```



Install Docker using on Ubuntu 20.04



```bash

sudo apt install apt-transport-https ca-certificates curl software-properties-common

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"

sudo apt-get update

sudo apt install docker-ce

```



Install Docker using on Ubuntu 18.04



```bash

sudo apt install apt-transport-https ca-certificates curl software-properties-common

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"

sudo apt-get update

sudo apt install docker-ce

```



Install Syncthing



```bash

sudo curl -o /usr/share/keyrings/syncthing-archive-keyring.gpg https://syncthing.net/release-key.gpg

echo 'deb [signed-by=/usr/share/keyrings/syncthing-archive-keyring.gpg] https://apt.syncthing.net/ syncthing stable' | sudo tee /etc/apt/sources.list.d/syncthing.list

sudo apt install ca-certificates -y > /dev/null 2>&1

sudo apt-get update -y

sudo apt-get install syncthing -y

```



Install Netcat



```bash

sudo apt install netcat -y

```



Clone Flux repo (Ubuntu):



```bash

sudo apt-get install git



git clone https://github.com/runonflux/flux

```



Clone Flux repo (Redhat/CentOS):



```bash

sudo yum install git



git clone https://github.com/runonflux/flux

```



Allow Inbound Connections on UFW firewall - default ports (if ufw enabled):



```bash

sudo ufw allow 16126

sudo ufw allow 16127

sudo ufw allow 16128

sudo ufw allow 16129

```



Install Flux dependancies (Ubuntu/CentOS/Redhat):



```bash

cd flux



npm install

```



To run this as Production:



```bash

npm start

```



To run this as Development: Start both solutions with



```bash

npm run fluxdev

npm run homedev

```



THE SETUP ENDS HERE...

The following information below provided for brief usage guidelines and/or examples only.



## Flux Home Information



> Frontend interface to interact with the Flux network

> Uses port 16126 by default



## Build Setup



```bash

# serve with hot reload at localhost:16126

npm run homedev



# build for production with minification

npm run homebuild



# build for production and view the bundle analyzer report

npm run homebuild --report

```



## Flux Information



> Backend interface to interact with the Flux Network

> Uses port 16127 by default



## Continued Build Setup



```bash

# serve with hot reload at localhost:16126

npm run fluxdev

```



Made with ❤️ by the Flux Team