Go to file
2023-04-11 15:23:43 -07:00
.design enabling contribute.design 2022-12-02 10:50:29 -08:00
.github/workflows Update ci.yml 2023-01-27 21:19:04 -08:00
app/mobile fixing create permission handling 2023-04-10 10:07:52 -07:00
doc implemented remainder of endpoints for signal bridging 2023-03-21 13:56:09 -07:00
net seems to work but not at all 2023-04-11 15:23:43 -07:00
.gitignore adding http utility functions 2022-01-17 13:27:48 -08:00
LICENSE Initial commit 2021-12-20 13:45:17 -08:00
README.md Update README.md 2023-02-27 20:57:35 -08:00

contribute.design

Databag

Communication for the Decentralized Web


  

Mobile and Browser App Screens


Databag is a self-hosted messaging service. Notable features include:

  • Public-private key based identity (not bound to any blockchain or hosting domain)
  • End-to-end encryption (the hosting admin cannot view sealed topics)
  • Federated (accounts on different nodes can communicate)
  • Topic based threads (messages organized by topic not contacts)
  • Lightweight (server runs on a raspberry pi zero v1.3)
  • Decentralized (direct communication between app and contact's node)
  • Low latency (use of websockets for push events to avoid polling)
  • Responsive (renders well on phone, tablet and pc)
  • Unlimited accounts per node (host for your whole family)
  • Mobile alerts (push notifications on new contacts and messages)

The app is available in the google and apple stores. You can also test out the project here, but don't post anything important as this server is regularly wiped. Feedback on the UI/UX, bugs or features is greatly appreciated.

Installation

To use databag, you will need a DNS name pointing to your node with a certificate. You can deploy a node manually, but you will have a much easier time using a container service. Containers for arm64 and amd64 are available here.

Docker Compose Command

From the net/container sub directory:

  • sudo docker-compose -f compose.yaml -p databag up

Example with Portainer and Nginx Proxy Manager

From Portainer:

  • In the volume view, click add volumen:
    • Enter a name, then click 'Create the volume'
  • In the container view, click add container:
    • In the 'Image' field enter 'balzack/databag:latest'
    • Click 'publish a new network port', and select port 7000 for both host and container
    • Under 'Advanced container settings', select 'Env', and click 'Add Environment Variable'
      • Enter 'Name' as 'ADMIN' and your admin password [password]
    • Under 'Advanced container settings', select 'Volumes', then 'map additional volume'
      • Enter '/var/lib/databag' for 'container' and the created volume for 'volume'
    • Click 'Deploy the Container'

From Nginx Proxy Manager:

  • Add a host and specify:
    • Hostname [hostname.domain]
    • Portainer IP address [address]
    • Port '7000'
    • Request new SSL certificate

From Your Browser:

  • Enter your server address in the address bar [hostname.domain]
    • Click the cog icon in the top right
    • Enter your admin password: [password]
    • Click the cog icon in the dashboard
      • Enter Federated Host as [hostname.domain]
      • Click 'Save'
    • Click the user icon to generate a new account link
      • Follow the link to create an account

Other installation options

Instruction for installing without a container on a Raspberry Pi Zero are here.

Instruction for installing without a container in AWS are here.