https://github.com/threefoldtech/freeflow_twin_main
https://github.com/threefoldtech/freeflow_twin_main
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/threefoldtech/freeflow_twin_main
- Owner: threefoldtech
- License: apache-2.0
- Created: 2021-06-10T15:13:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-02T08:55:16.000Z (12 months ago)
- Last Synced: 2024-06-02T10:12:39.066Z (12 months ago)
- Language: TypeScript
- Size: 12.4 MB
- Stars: 4
- Watchers: 8
- Forks: 3
- Open Issues: 103
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# twin_aydo
# Current stack
FreeFlow currently has 5 different components:
- Dashboard (posts)
- Whisper (messaging)
- Quantum (file sharing)
- Glass (secure browsing)
- Kutana (meetings)
## Dashboard
Flow is a social section where you can keep in touch with all your contacts.
Codebase for Dasbhoard: https://github.com/threefoldtech/twin_aydo/
## Whisper
Whisper is a fully fledged chat service with all the features you'd expect from an advanced chat service like telegram or whatsapp.
Codebase for Whisper: https://github.com/threefoldtech/twin_aydo/
## Quantum
Quantum is a full file management system, including an open-source office files editor.
Codebase for Quantum: https://github.com/threefoldtech/twin_aydo/
## Glass
Glass is a safe browsing experience using browser isolation technology. You can read more about browser isolation at https://jimber.io/en/what-is-browser-isolation-jimber/
Codebase for Glass: https://github.com/JimberSoftware/browser
### Kutana
Kutana is a meetings tool like zoom, which allows anyone to do safe video meetings without having to entrust your data to third-party services like zoom or google.
Codebase for Kutana: https://github.com/freeflowuniverse/freeflow_kutana_ui
# Development setup
## Network
Create a docker network so internal communication is possible
```console
docker network create chatnet
```
## Spawner
Go to the Spawner
```console
cd apps/spawner
```
In the docker-compose.yaml you need to adjust 2 lines to make it work.
- On line 11 there is a folder mapped to `/config`. Either map a folder to it or just comment it out when no config is neeeded.
- 0n line 24 you need to map some certifications. There is a `certs` folder included in this project, use these. `../certs`
Then run inside the `spawner` folder.
```console
docker-compose up
```
Use `-d` to detach the process.
## Chat containers
Go into dev folder
```console
cd ../docker/dev
```
Creation of appdata
```console
mkdir ./appdata
mkdir ./appdata/chats
mkdir ./appdata/user
cp ../avatar.jpg ./appdata/user/avatar-default
```
Add or edit instances for the chat application in the docker-compose file. There should be an example commented where `$3bot` can be replace with any 3bot name.
- Make sure every user has his own `appdata` folder!
- Make sure the container name end with '-chat'
- If you don't want the staging login flow, remove the `ENVIRONMENT=developement` or change to `production`
Build the containers
```console
docker compose up
```
Use `-d` to detach the process.
## Hosts file
Add two rules to the hosts file, change `$3bot` to the configured 3bot name in the docker-compose file. Duplicate for every `chat` containter.
```console
sudo vim /etc/hosts
```
```
127.0.0.1 digitaltwin.jimbertesting.be
127.0.0.1 $3bot.digitaltwin.jimbertesting.be
```