2 <a href="" rel="noopener">
3 <img width=200px height=200px src="ui/assets/favicon.svg"></a>
6 <h3 align="center">Lemmy</h3>
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)
27 <p align="center">A link aggregator / reddit clone for the fediverse.
31 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
33 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
37 ![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png)
39 ## 📝 Table of Contents
43 - [Features](#features)
45 * [Why's it called Lemmy?](#whys-it-called-lemmy)
48 + [Updating](#updating)
50 * [Kubernetes](#kubernetes)
52 * [Docker Development](#docker-development)
53 * [Local Development](#local-development)
54 + [Requirements](#requirements)
55 + [Set up Postgres DB](#set-up-postgres-db)
57 - [Documentation](#documentation)
59 - [Translations](#translations)
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 - Cross-posting support.
78 - A *similar post search* when creating new posts. Great for question / answer communities.
79 - Moderation abilities.
80 - Public Moderation Logs.
81 - Both site admins, and community moderators, who can appoint other moderators.
82 - Can lock, remove, and restore posts and comments.
83 - Can ban and unban users from communities and the site.
84 - Can transfer site and communities to others.
85 - Can fully erase your data, replacing all posts and comments.
86 - NSFW post / community support.
88 - Server is written in rust.
89 - Front end is `~80kB` gzipped.
90 - Supports arm64 / Raspberry Pi.
94 [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 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 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 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 ### Why's it called Lemmy?
104 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
105 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
106 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
107 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
109 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/).
115 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
120 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
121 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
122 # Edit the .env if you want custom passwords
126 and go to http://localhost:8536.
128 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
131 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
132 # Replace the {{ vars }}
133 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
137 To update to the newest version, run:
140 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
146 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 Then run the following commands on your local computer:
151 git clone https://github.com/dessalines/lemmy.git
153 cp inventory.example inventory
154 nano inventory # enter your server, domain, contact email
155 ansible-playbook lemmy.yml --become
160 You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/).
161 Setting this up will vary depending on your provider.
162 To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
164 Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`.
165 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.
166 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 **Important** Running a database in Kubernetes will work, but is generally not recommended.
169 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.).
174 # Add `-n foo` if you want to deploy into a specific namespace `foo`;
175 # otherwise your resources will be created in the `default` namespace.
176 kubectl apply -f docker/k8s/db.yml
177 kubectl apply -f docker/k8s/pictshare.yml
178 kubectl apply -f docker/k8s/lemmy.yml
181 If you used a `LoadBalancer`, you should see it in your cloud provider's console.
185 ### Docker Development
190 git clone https://github.com/dessalines/lemmy
192 ./docker_update.sh # This builds and runs it, updating for your changes
195 and go to http://localhost:8536.
197 ### Local Development
201 - [Rust](https://www.rust-lang.org/)
202 - [Yarn](https://yarnpkg.com/en/)
203 - [Postgres](https://www.postgresql.org/)
205 #### Set up Postgres DB
208 psql -c "create user lemmy with password 'password' superuser;" -U postgres
209 psql -c 'create database lemmy with owner lemmy;' -U postgres
210 export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
216 git clone https://github.com/dessalines/lemmy
219 # For live coding, where both the front and back end, automagically reload on any save, do:
220 # cd ui && yarn start
221 # cd server && cargo watch -x run
226 - [Websocket API for App developers](docs/api.md)
227 - [ActivityPub API.md](docs/apub_api_outline.md)
228 - [Goals](docs/goals.md)
229 - [Ranking Algorithm](docs/ranking.md)
233 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 - [Support on Patreon](https://www.patreon.com/dessalines).
236 - [Sponsor List](https://dev.lemmy.ml/sponsors).
237 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
238 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
239 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
243 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
245 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
247 lang | done | missing
249 de | 81% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,subscribed,replies,mentions,expires,recent_comments,nsfw,show_nsfw,theme,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
250 eo | 90% | number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,theme,are_you_sure,yes,no
251 es | 99% | replies,mentions
252 fr | 99% | replies,mentions
254 nl | 92% | preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,theme
255 ru | 86% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
256 sv | 99% | replies,mentions
257 zh | 83% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
259 If you'd like to update this report, run:
263 ts-node translation_report.ts > tmp # And replace the text above.
268 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.