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)](https://mastodon.social/@LemmyDev)
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/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.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 - [Configuration](#configuration)
58 - [Documentation](#documentation)
60 - [Translations](#translations)
67 - Open source, [AGPL License](/LICENSE).
68 - Self hostable, easy to deploy.
69 - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
70 - Clean, mobile-friendly interface.
71 - Live-updating Comment threads.
72 - Full vote scores `(+/-)` like old reddit.
73 - Themes, including light, dark, and solarized.
74 - Emojis with autocomplete support. Start typing `:`
75 - User tagging using `@`, Community tagging using `#`.
76 - Notifications, on comment replies and when you're tagged.
77 - i18n / internationalization support.
78 - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
79 - Cross-posting support.
80 - A *similar post search* when creating new posts. Great for question / answer communities.
81 - Moderation abilities.
82 - Public Moderation Logs.
83 - Both site admins, and community moderators, who can appoint other moderators.
84 - Can lock, remove, and restore posts and comments.
85 - Can ban and unban users from communities and the site.
86 - Can transfer site and communities to others.
87 - Can fully erase your data, replacing all posts and comments.
88 - NSFW post / community support.
90 - Server is written in rust.
91 - Front end is `~80kB` gzipped.
92 - Supports arm64 / Raspberry Pi.
96 [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).
98 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.
100 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.
102 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.
104 ### Why's it called Lemmy?
106 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
107 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
108 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
109 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
111 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/).
117 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
122 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
123 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
124 # Edit lemmy.hjson to do more configuration
128 and go to http://localhost:8536.
130 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
133 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
134 # Replace the {{ vars }}
135 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
139 To update to the newest version, run:
142 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
148 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.
150 Then run the following commands on your local computer:
153 git clone https://github.com/dessalines/lemmy.git
155 cp inventory.example inventory
156 nano inventory # enter your server, domain, contact email
157 ansible-playbook lemmy.yml --become
162 You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/).
163 Setting this up will vary depending on your provider.
164 To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
166 Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`.
167 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.
168 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.
170 **Important** Running a database in Kubernetes will work, but is generally not recommended.
171 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.).
176 # Add `-n foo` if you want to deploy into a specific namespace `foo`;
177 # otherwise your resources will be created in the `default` namespace.
178 kubectl apply -f docker/k8s/db.yml
179 kubectl apply -f docker/k8s/pictshare.yml
180 kubectl apply -f docker/k8s/lemmy.yml
183 If you used a `LoadBalancer`, you should see it in your cloud provider's console.
187 ### Docker Development
192 git clone https://github.com/dessalines/lemmy
194 ./docker_update.sh # This builds and runs it, updating for your changes
197 and go to http://localhost:8536.
199 ### Local Development
203 - [Rust](https://www.rust-lang.org/)
204 - [Yarn](https://yarnpkg.com/en/)
205 - [Postgres](https://www.postgresql.org/)
207 #### Set up Postgres DB
210 psql -c "create user lemmy with password 'password' superuser;" -U postgres
211 psql -c 'create database lemmy with owner lemmy;' -U postgres
212 export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
218 git clone https://github.com/dessalines/lemmy
221 # For live coding, where both the front and back end, automagically reload on any save, do:
222 # cd ui && yarn start
223 # cd server && cargo watch -x run
228 The configuration is based on the file [defaults.hjson](server/config/defaults.hjson). This file also contains documentation for all the available options. To override the defaults, you can copy the options you want to change into your local `config.hjson` file.
230 Additionally, you can override any config files with environment variables. These have the same name as the config options, and are prefixed with `LEMMY_`. For example, you can override the `database.password` with
231 `LEMMY__DATABASE__POOL_SIZE=10`.
233 An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL connection string like `postgres://lemmy:password@lemmy_db:5432/lemmy`, passing all connection details at once.
237 - [Websocket API for App developers](docs/api.md)
238 - [ActivityPub API.md](docs/apub_api_outline.md)
239 - [Goals](docs/goals.md)
240 - [Ranking Algorithm](docs/ranking.md)
244 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
246 - [Support on Patreon](https://www.patreon.com/dessalines).
247 - [Sponsor List](https://dev.lemmy.ml/sponsors).
248 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
249 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
250 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
254 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
256 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
258 lang | done | missing
260 de | 97% | avatar,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
261 eo | 84% | number_of_communities,preview,upload_image,avatar,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,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme,are_you_sure,yes,no
262 es | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
263 fr | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
264 it | 93% | avatar,archive_link,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
265 nl | 86% | preview,upload_image,avatar,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,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme
266 ru | 80% | cross_posts,cross_post,number_of_communities,preview,upload_image,avatar,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,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
267 sv | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
268 zh | 78% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,avatar,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,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
271 If you'd like to update this report, run:
275 ts-node translation_report.ts > tmp # And replace the text above.
280 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.