The official GitHub repository for Arkavo's Web Backend and React App - an integrated security and AI platform.
Note
The official secure Arkavo hosted backend is FREE to use!
Most users wanting to host their own platform should refer to the WebApp Readme.
If you insist on running your own backend, read on.
- A public, internet-facing host (e.g., AWS EC2 instance)
- Git The Setup script can install
- Docker
- Python
-
Clone the repository
git clone https://github.com/arkavo-org/arkavo-platform/ cd arkavo-platform
-
Run the backend initially
python run.py
This will generate all your template files.
-
Configure your instance
- Edit
editme.py
to customize your brand name and colors - Obtain necessary SSL certificates and copy them as
fullchain.pem
andprivkey.pem
in/certs
directory
- Edit
-
Launch with templates
python run.py
-
Verify installation
- Navigate to
https://yourhost/
to ensure the included frontend is running
- Navigate to
Arkavo Platform integrates best-in-class tools for Security and AI, arranged to work together with minimal configuration.
Component | Description |
---|---|
Ollama | Best-in-class open-source LLM management solution |
Keycloak | Best-in-class open-source identity and authentication solution |
OpenTDF | Best-in-class Attribute-Based Access Control (ABAC) addendum to Keycloak |
Org | Handles organizational needs - Events, Communications, Permissions |
Nginx-Proxy | Serves other services via HTTPS |
Synapse | Best-in-class open-source Instant Messenger solution |
graph LR
%% Define components with styling
Keycloak["Keycloak+DB"]:::auth
OpenTDF["OpenTDF+DB"]:::security
OrgBackend["Org-Backend"]:::backend
ReactFrontend["React-Frontend"]:::frontend
%% Connections with labels
OpenTDF -->|Authenticates with| Keycloak
OrgBackend -->|Authenticates with| Keycloak
ReactFrontend -->|Authenticates with| Keycloak
ReactFrontend -->|Interacts with| OpenTDF
ReactFrontend -->|Interacts with| OrgBackend
%% Styling
classDef auth fill:#f9d,stroke:#333,stroke-width:2px
classDef security fill:#ad5,stroke:#333,stroke-width:2px
classDef backend fill:#5ad,stroke:#333,stroke-width:2px
classDef frontend fill:#da5,stroke:#333,stroke-width:2px
For more detailed information about each component:
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
Join our WhatsApp Group for community support.