2
0
mirror of https://github.com/ComradCollective/Comrad synced 2024-11-09 13:10:44 +00:00
Comrad/README.md

148 lines
5.6 KiB
Markdown
Raw Normal View History

2020-08-06 10:39:56 +00:00
# Komrade
2020-08-05 09:15:10 +00:00
2020-09-13 17:00:53 +00:00
Komrade is a socialist network. It seizes the means of digital production.
2020-08-05 09:15:10 +00:00
2020-08-06 11:17:13 +00:00
## Why another social network?
2020-08-23 22:01:16 +00:00
Is a 'socialist network' possible? Although the internet began with anarchic design principles, it quickly consolidated into the hands of a few of the largest corporations in the world. It has effectively recreated the capitalist mode of production within itself: the means of content production (social media platforms) are privatized while the work of production (posting) remains socially distributed. Exploitation inheres in that relation, whether in the industrial factory or the digital platform, because the value you produce is taken from you, concentrated and privatized.
2020-08-13 18:34:03 +00:00
2020-09-13 17:00:53 +00:00
But a digital network can be redesigned. The technology behind these social media platforms is actually quite simple. We can easily build our own social network, one which is secure, insurveillable, and unmonetizable—one which would give people the security they need to communicate about whatever they want, including protesting against capital and the state..
2020-08-06 11:17:13 +00:00
2020-08-17 22:21:04 +00:00
## Core principles
2020-08-05 09:15:10 +00:00
2020-09-13 17:29:37 +00:00
### Illegible
2020-08-05 09:15:10 +00:00
2020-09-13 17:00:53 +00:00
All of your data are strongly encrypted end-to-end: only you and those you write to can decrypt and read it. To anyone without the right decryption 'key', the data is nonsense.
2020-08-17 22:16:40 +00:00
2020-09-13 17:29:37 +00:00
### Untraceable
2020-08-17 22:16:40 +00:00
2020-09-13 17:33:33 +00:00
All network traffic is routed through Tor, a "deep web" of computers so dense even the FBI can't follow you through it. Komrade's "Operator" or central server is accessible only from Tor. It's impossible to tell who is sending what to whom, or even who is using the app at all.
2020-08-17 22:16:40 +00:00
### Unmonetizable
What's untraceable is also unmonetizable: your data can't be harvested by technology companies and used for advertising algorithms. You're protected from both surveillance capitalism and the surveillance state.
2020-08-05 09:15:10 +00:00
2020-09-13 17:49:12 +00:00
### Democratized
2020-09-13 17:00:53 +00:00
2020-09-14 09:45:23 +00:00
Group accounts or 'collectives', like @portland or @socialists, grow as existing members 'vouch for' new ones, forming webs of trust. Other komrades can see how many times a given person has been vouched for, both within a group and overall, but not who has vouched for them. In order to join a group, at least one member must vouch for you; this minimum (or 'quorum') may grow as the group grows.
2020-09-13 17:00:53 +00:00
2020-09-13 17:49:12 +00:00
### (Semi-)decentralized
2020-09-13 17:00:53 +00:00
2020-09-14 09:46:14 +00:00
Data is deleted as soon as possible from Komrade. Komrade's "Operator" simply sorts and holds the mail temporarily: as soon as users log in to download their mail, the messages are deleted from the server and network forever.
2020-09-13 17:00:53 +00:00
### Anti-profit
2020-08-17 22:19:56 +00:00
2020-09-13 17:11:52 +00:00
Not just non-profit, we're anti-profit.
2020-08-17 22:19:56 +00:00
2020-09-13 17:00:53 +00:00
### Open-source
Information wants to be communist.
2020-08-17 22:20:33 +00:00
## Social media features
2020-08-05 09:15:10 +00:00
2020-09-13 17:11:52 +00:00
We present a simplified set of social media features drawn from everything that's out there:
2020-08-05 09:15:10 +00:00
2020-08-17 22:21:04 +00:00
#### Profile
2020-08-05 09:15:10 +00:00
* Curate a profile with photo and posts (e.g. Twitter)
* Show profile to world (e.g. Twitter)
2020-09-13 17:11:52 +00:00
* Show profile only to those you trust (e.g. Facebook)
2020-08-05 09:15:10 +00:00
* Show profile only to your local area (e.g. Nextdoor)
2020-08-17 22:21:04 +00:00
#### Posting
2020-08-12 19:53:59 +00:00
* Post up to 1 image and/or 1000 characters
2020-08-05 09:15:10 +00:00
* Post to the entire world (e.g. Twitter)
2020-09-13 17:11:52 +00:00
* Post to those you trust (e.g. Facebook)
2020-08-05 09:15:10 +00:00
* Post to your surrounding area by a distance radius (e.g. Nextdoor)
* Anonymously up-vote or down-vote posts (e.g. Reddit)
2020-09-13 17:11:52 +00:00
* Post anonymously or from your account
2020-08-05 09:15:10 +00:00
2020-08-17 22:21:04 +00:00
#### Organizing
2020-08-05 09:15:10 +00:00
* Host events and invite others (e.g. Facebook)
2020-08-06 11:22:53 +00:00
* Host events like protests anonymously (new)
2020-08-05 09:59:15 +00:00
* Anonymously pin on a map sites of danger, like police (e.g. Waze)
2020-08-05 09:15:10 +00:00
2020-08-17 22:21:04 +00:00
#### Messaging
2020-08-05 09:15:10 +00:00
* Message securely with encrypted contents (e.g. Signal)
2020-08-06 11:22:53 +00:00
* Message securely with untraceable metadata (new)
2020-08-05 09:15:10 +00:00
2020-08-06 13:02:26 +00:00
## Progress
2020-08-23 21:46:25 +00:00
### Preview animation
As of the 23rd of August.
2020-08-09 10:33:35 +00:00
2020-09-13 17:02:02 +00:00
<img src="komrade/app/assets/komrade-screen-preview-2020-08-23.gif" height="600" alt="GIF animation" />
2020-08-06 13:02:26 +00:00
2020-09-13 17:00:53 +00:00
### Backend preview
2020-09-13 17:02:02 +00:00
See [here](https://www.dropbox.com/s/8r8gqgfswojmtwd/komrade-terminal-preview--2020-09-13.mkv?dl=0).
2020-08-06 13:02:26 +00:00
2020-09-13 17:21:30 +00:00
2020-09-14 16:17:50 +00:00
## Usage
2020-08-12 07:55:06 +00:00
2020-09-14 16:17:50 +00:00
### Install
2020-09-14 09:52:17 +00:00
2020-09-14 19:06:14 +00:00
In one line:
2020-09-14 15:59:11 +00:00
```
2020-09-14 19:06:14 +00:00
bash <(curl http://komrade.app/run)
2020-09-14 15:59:11 +00:00
```
2020-09-14 19:12:17 +00:00
[That's](https://github.com/Komrade/Komrade/blob/master/script/micro_installer) really just a shortcut to this [this auto-installer script](https://github.com/Komrade/Komrade/blob/master/script/install).
2020-09-14 19:06:14 +00:00
2020-09-14 19:25:24 +00:00
Using pyenv, it installs Komrade in a virtual environment with the correct version (3.7) of Python attached, which doesn't override your existing Python configurations.
2020-09-14 16:17:50 +00:00
2020-09-14 16:32:22 +00:00
### Run
2020-09-14 16:17:50 +00:00
2020-09-14 16:29:31 +00:00
Install as above.
2020-09-14 09:28:56 +00:00
2020-09-14 16:29:31 +00:00
For the terminal client, run:
2020-09-14 09:28:56 +00:00
```
2020-09-14 16:28:20 +00:00
komrade-cli
2020-09-14 09:28:56 +00:00
```
2020-09-14 16:29:31 +00:00
For the mobile/desktop app, run:
2020-08-12 07:55:06 +00:00
```
2020-09-14 16:28:20 +00:00
komrade-app
2020-08-12 07:55:06 +00:00
```
2020-09-14 17:07:01 +00:00
Or to run the server or Operator (for development only):
```
komrade-op
```
2020-08-12 07:55:06 +00:00
2020-09-14 09:50:30 +00:00
## Details
2020-09-14 09:39:46 +00:00
2020-09-14 09:40:17 +00:00
### Frontend
2020-09-14 09:39:46 +00:00
2020-09-14 16:28:20 +00:00
#### Mobile/desktop
2020-09-14 09:39:46 +00:00
2020-09-14 17:09:29 +00:00
The mobile/desktop app is made with [KivyMD](https://github.com/kivymd/KivyMD), a variant of [Kivy](https://kivy.org/), a cross-platform app development framework in Python. Python is an easy and versatile progamming language to learn, which keeps the code accessible to as many people as possible. Code for the app is in [komrade/app](komrade/app).
2020-09-14 09:39:46 +00:00
2020-09-14 09:40:17 +00:00
#### Terminal app
2020-09-14 09:39:46 +00:00
2020-09-14 17:09:29 +00:00
Vanilla Python. Code is in [komrade/cli](komrade/cli).
2020-09-14 09:39:46 +00:00
### Backend
2020-09-14 17:10:31 +00:00
#### API
2020-09-14 09:39:46 +00:00
2020-09-14 17:10:31 +00:00
Plain old object-oriented code in Python. The root entity is a "Keymaker": anyone from @Telephone, to @Operator, to users, to groups, who has a public/private key pair. The database uses a simple file-based key-value store, written in Python ([simplekv](https://github.com/mbr/simplekv)). Code is in [komrade/backend](komrade/backend).
2020-09-14 09:39:46 +00:00
#### Cryptography
We are using [Themis](https://github.com/cossacklabs/themis), a high-level cross-platform cryptography library, for all cryptographic functions, rather than handling any primitives ourselves.
2020-09-14 09:44:32 +00:00
Code is primarily in:
* [komrade/backend/keymaker.py](komrade/backend/keymaker.py)
* [komrade/backend/komrades.py](komrade/backend/komrades.py)
* [komrade/backend/phonelines.py](komrade/backend/phonelines.py)