README.md

   1 <p align="center">
   2   <a href="" rel="noopener">
   3  <img width=200px height=200px src="ui/assets/favicon.svg"></a>
   4 </p>
   5
   6 <h3 align="center">Lemmy</h3>
   7
   8 <div align="center">
   9
  10 [![Github](https://img.shields.io/badge/-Github-blue)](https://github.com/dessalines/lemmy)
  11 [![Gitlab](https://img.shields.io/badge/-Gitlab-yellowgreen)](https://gitlab.com/dessalines/lemmy)
  12 ![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)
  13 ![GitHub stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
  14 [![Matrix](https://img.shields.io/matrix/rust-reddit-fediverse:matrix.org.svg?label=matrix-chat)](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
  15 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
  16 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
  17 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  18 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
  19 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  20 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  21 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  22 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
  23 </div>
  24
  25 ---
  26
  27 <p align="center">A link aggregator / reddit clone for the fediverse.
  28     <br>
  29 </p>
  30
  31 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
  32
  33 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
  34
  35 Front Page|Post
  36 ---|---
  37 ![main screen](https://i.imgur.com/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.png)
  38
  39 ## 📝 Table of Contents
  40
  41 <!-- toc -->
  42
  43 - [Features](#features)
  44 - [About](#about)
  45   * [Why's it called Lemmy?](#whys-it-called-lemmy)
  46 - [Install](#install)
  47   * [Docker](#docker)
  48     + [Updating](#updating)
  49   * [Ansible](#ansible)
  50   * [Kubernetes](#kubernetes)
  51 - [Develop](#develop)
  52   * [Docker Development](#docker-development)
  53   * [Local Development](#local-development)
  54     + [Requirements](#requirements)
  55     + [Set up Postgres DB](#set-up-postgres-db)
  56     + [Running](#running)
  57 - [Documentation](#documentation)
  58 - [Support](#support)
  59 - [Translations](#translations)
  60 - [Credits](#credits)
  61
  62 <!-- tocstop -->
  63
  64 ## Features
  65
  66 - Open source, [AGPL License](/LICENSE).
  67 - Self hostable, easy to deploy.
  68   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  69 - Clean, mobile-friendly interface.
  70   - Live-updating Comment threads.
  71   - Full vote scores `(+/-)` like old reddit.
  72   - Themes, including light, dark, and solarized.
  73   - Emojis with autocomplete support. Start typing `:`
  74   - User tagging using `@`, Community tagging using `#`.
  75   - Notifications, on comment replies and when you're tagged.
  76   - i18n / internationalization support.
  77   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  78 - Cross-posting support.
  79   - A *similar post search* when creating new posts. Great for question / answer communities.
  80 - Moderation abilities.
  81   - Public Moderation Logs.
  82   - Both site admins, and community moderators, who can appoint other moderators.
  83   - Can lock, remove, and restore posts and comments.
  84   - Can ban and unban users from communities and the site.
  85   - Can transfer site and communities to others.
  86 - Can fully erase your data, replacing all posts and comments.
  87 - NSFW post / community support.
  88 - High performance.
  89   - Server is written in rust.
  90   - Front end is `~80kB` gzipped.
  91   - Supports arm64 / Raspberry Pi.
  92
  93 ## About
  94
  95 [Lemmy](https://github.com/dessalines/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), [Raddle](https://raddle.me), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
  96
  97 For a link aggregator, this means a user registered on one server can subscribe to forums on any other server, and can have discussions with users registered elsewhere.
  98
  99 The overall goal is to create an easily self-hostable, decentralized alternative to reddit and other link aggregators, outside of their corporate control and meddling.
 100
 101 Each lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing.
 102
 103 ### Why's it called Lemmy?
 104
 105 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
 106 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
 107 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
 108 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
 109
 110 Made with [Rust](https://www.rust-lang.org), [Actix](https://actix.rs/), [Inferno](https://www.infernojs.org), [Typescript](https://www.typescriptlang.org/) and [Diesel](http://diesel.rs/).
 111
 112 ## Install
 113
 114 ### Docker
 115
 116 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
 117
 118 ```bash
 119 mkdir lemmy/
 120 cd lemmy/
 121 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 122 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
 123 # Edit the .env if you want custom passwords
 124 docker-compose up -d
 125 ```
 126
 127 and go to http://localhost:8536.
 128
 129 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
 130
 131 ```bash
 132 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
 133 # Replace the {{ vars }}
 134 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
 135 ```
 136 #### Updating
 137
 138 To update to the newest version, run:
 139
 140 ```bash
 141 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 142 docker-compose up -d
 143 ```
 144
 145 ### Ansible
 146
 147 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform.
 148
 149 Then run the following commands on your local computer:
 150
 151 ```bash
 152 git clone https://github.com/dessalines/lemmy.git
 153 cd lemmy/ansible/
 154 cp inventory.example inventory
 155 nano inventory # enter your server, domain, contact email
 156 ansible-playbook lemmy.yml --become
 157 ```
 158
 159 ### Kubernetes
 160
 161 You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/).
 162 Setting this up will vary depending on your provider.
 163 To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
 164
 165 Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`.
 166 You may also want to change the service types to use `LoadBalancer`s depending on where you're running your cluster (add `type: LoadBalancer` to `ports)`, or `NodePort`s.
 167 By default they will use `ClusterIP`s, which will allow access only within the cluster. See the [docs](https://kubernetes.io/docs/concepts/services-networking/service/) for more on networking in Kubernetes.
 168
 169 **Important** Running a database in Kubernetes will work, but is generally not recommended.
 170 If you're deploying on any of the common cloud providers, you should consider using their managed database service instead (RDS, Cloud SQL, Azure Databse, etc.).
 171
 172 Now you can deploy:
 173
 174 ```bash
 175 # Add `-n foo` if you want to deploy into a specific namespace `foo`;
 176 # otherwise your resources will be created in the `default` namespace.
 177 kubectl apply -f docker/k8s/db.yml
 178 kubectl apply -f docker/k8s/pictshare.yml
 179 kubectl apply -f docker/k8s/lemmy.yml
 180 ```
 181
 182 If you used a `LoadBalancer`, you should see it in your cloud provider's console.
 183
 184 ## Develop
 185
 186 ### Docker Development
 187
 188 Run:
 189
 190 ```bash
 191 git clone https://github.com/dessalines/lemmy
 192 cd lemmy/docker/dev
 193 ./docker_update.sh # This builds and runs it, updating for your changes
 194 ```
 195
 196 and go to http://localhost:8536.
 197
 198 ### Local Development
 199
 200 #### Requirements
 201
 202 - [Rust](https://www.rust-lang.org/)
 203 - [Yarn](https://yarnpkg.com/en/)
 204 - [Postgres](https://www.postgresql.org/)
 205
 206 #### Set up Postgres DB
 207
 208 ```bash
 209  psql -c "create user lemmy with password 'password' superuser;" -U postgres
 210  psql -c 'create database lemmy with owner lemmy;' -U postgres
 211  export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
 212 ```
 213
 214 #### Running
 215
 216 ```bash
 217 git clone https://github.com/dessalines/lemmy
 218 cd lemmy
 219 ./install.sh
 220 # For live coding, where both the front and back end, automagically reload on any save, do:
 221 # cd ui && yarn start
 222 # cd server && cargo watch -x run
 223 ```
 224
 225 ## Documentation
 226
 227 - [Websocket API for App developers](docs/api.md)
 228 - [ActivityPub API.md](docs/apub_api_outline.md)
 229 - [Goals](docs/goals.md)
 230 - [Ranking Algorithm](docs/ranking.md)
 231
 232 ## Support
 233
 234 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 235
 236 - [Support on Patreon](https://www.patreon.com/dessalines).
 237 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 238 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 239 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 240 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 241
 242 ## Translations
 243
 244 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
 245
 246 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
 247
 248 lang | done | missing
 249 --- | --- | ---
 250 de | 79% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,archive_link,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,subscribed,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,expires,recent_comments,nsfw,show_nsfw,theme,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 251 eo | 87% | number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,theme,are_you_sure,yes,no
 252 es | 96% | archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup
 253 fr | 96% | archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup
 254 it | 97% | archive_link,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup
 255 nl | 89% | preview,upload_image,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,theme
 256 ru | 83% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 257 sv | 96% | archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup
 258 zh | 81% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,archive_link,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 259
 260
 261 If you'd like to update this report, run:
 262
 263 ```bash
 264 cd ui
 265 ts-node translation_report.ts > tmp # And replace the text above.
 266 ```
 267
 268 ## Credits
 269
 270 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.