databag/README.md

72 lines
2.9 KiB
Markdown
Raw Normal View History

2022-11-01 16:36:13 +00:00
<div align="center">
2022-11-02 04:03:39 +00:00
<a href="#"><img src="/doc/icon.png" width="8%" style="border-radius:50%"></a>
2022-11-01 16:36:13 +00:00
<h3 align="center">Databag</h3>
<p align="center">Communication for the Decentralized Web</p>
</div>
<br>
2022-06-10 17:58:34 +00:00
<p align="center">
2022-11-01 07:55:25 +00:00
<a href="/doc/mobile.png"><img src="/doc/mobile.png" width="48%"/></a>
2022-11-01 07:41:40 +00:00
&nbsp;&nbsp;
2022-11-01 07:55:25 +00:00
<a href="/doc/browser.png"><img src="/doc/browser.png" width="48%"/></a>
2022-06-10 17:58:34 +00:00
</p>
2022-11-01 07:41:40 +00:00
<p align="center">
2022-11-01 20:46:03 +00:00
<sub>Mobile and Browser App Screens</sub>
2022-11-01 07:41:40 +00:00
</p>
<br>
2022-06-10 17:58:34 +00:00
2022-11-02 17:15:52 +00:00
Databag is a self-hosted messaging service. Notable features include:
2022-07-08 04:21:48 +00:00
- Public-private key based identity (not bound to any blockchain or hosting domain)
- Federated (accounts on different nodes can communicate)
2022-11-01 16:15:25 +00:00
- Lightweight (server runs on a raspberry pi zero v1.3)
2022-11-04 19:03:43 +00:00
- Decentralized (direct communication between app and contact's node)
2022-07-23 03:58:52 +00:00
- Low latency (use of websockets for push events to avoid polling)
2022-11-01 07:44:29 +00:00
- Responsive (renders well in phone, tablet and pc)
2022-07-23 03:58:52 +00:00
- Unlimited accounts per node (host for your whole family)
2022-06-10 18:47:18 +00:00
2022-11-01 07:41:40 +00:00
<br>
<p align="center">
<a href="https://apps.apple.com/us/app/databag/id6443741428">
<img src="/doc/astore.png" width="15%">
</a>
<a href="https://play.google.com/store/apps/details?id=com.databag">
<img src="/doc/gplay.png" width="15%">
</a>
</p>
2022-11-01 07:43:49 +00:00
The app is available in the google and apple stores. You can also test out the project [here](https://databag.coredb.org/#/create), but don't post anything important as this server is regularly wiped. Feedback on the UI/UX, bugs or features is greatly appreciated.
2022-06-10 19:04:29 +00:00
2022-07-25 20:19:16 +00:00
## Installation
2022-06-10 19:04:29 +00:00
2022-09-02 20:28:01 +00:00
To use databag, you will need a DNS name pointing to your node with a certificate. You can deloy a node manually, but you will have a much easier time using a container service. Containers for arm64 and amd64 are available [here](https://hub.docker.com/r/balzack/databag/tags).
2022-07-25 18:04:31 +00:00
2022-09-02 20:28:01 +00:00
Instruction for installing without a container on a Raspberry Pi Zero are [here](/doc/pizero.md).
2022-08-03 18:28:29 +00:00
2022-07-25 18:04:31 +00:00
### Example with Portainer and Nginx Proxy Manager
From Portainer:
- 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]
- 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