1 <h1><img src="ui/assets/favicon.svg" width="50px" height="50px" style="vertical-align:bottom" /><span>Lemmy</span></h1>
3 [![Github](https://img.shields.io/badge/-Github-blue)](https://github.com/dessalines/lemmy)
4 [![Gitlab](https://img.shields.io/badge/-Gitlab-yellowgreen)](https://gitlab.com/dessalines/lemmy)
5 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
6 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
7 [![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
8 [![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
9 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
10 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
11 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
12 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
13 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
14 [![Mastodon](https://img.shields.io/badge/Mastodon-@LemmyDev-lightgrey.svg)](https://mastodon.social/@LemmyDev)
15 [![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)
16 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
18 A link aggregator / reddit clone for the fediverse.
20 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
22 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
26 ![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png)
29 - Open source, [AGPL License](/LICENSE).
30 - Self hostable, easy to deploy.
31 - Comes with [Docker](#docker), [Ansible](#ansible).
32 - Live-updating Comment threads.
33 - Full vote scores `(+/-)` like old reddit.
34 - Moderation abilities.
35 - Public Moderation Logs.
36 - Both site admins, and community moderators, who can appoint other moderators.
37 - Can lock, remove, and restore posts and comments.
38 - Can ban and unban users from communities and the site.
39 - Clean, mobile-friendly interface.
40 - i18n / internationalization support.
41 - NSFW post / community support.
42 - Cross-posting support.
43 - Can transfer site and communities to others.
45 - Server is written in rust.
46 - Front end is `~80kB` gzipped.
50 [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).
52 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.
54 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.
56 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.
58 ## Why's it called Lemmy?
60 - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
61 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
62 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
63 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
65 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/).
71 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
76 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
77 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
78 # Edit the .env if you want custom passwords
82 and goto http://localhost:8536
84 [A sample nginx config](/docker/prod/nginx.conf), could be setup with:
87 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/nginx.conf
88 # Replace the {{ vars }}
89 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
94 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
95 eg using `sudo apt install ansible`, or the equivalent for you platform.
97 Then run the following commands on your local computer:
100 git clone https://github.com/dessalines/lemmy.git
102 cp inventory.example inventory
103 nano inventory # enter your server, domain, contact email
104 ansible-playbook lemmy.yml
109 ### Docker Development
112 git clone https://github.com/dessalines/lemmy
114 ./docker_update.sh # This builds and runs it, updating for your changes
117 and goto http://localhost:8536
119 ### Local Development
123 - [Rust](https://www.rust-lang.org/)
124 - [Yarn](https://yarnpkg.com/en/)
125 - [Postgres](https://www.postgresql.org/)
127 #### Set up Postgres DB
130 psql -c "create user lemmy with password 'password' superuser;" -U postgres
131 psql -c 'create database lemmy with owner lemmy;' -U postgres
132 export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
138 git clone https://github.com/dessalines/lemmy
141 # For live coding, where both the front and back end, automagically reload on any save, do:
142 # cd ui && yarn start
143 # cd server && cargo watch -x run
148 - [Websocket API for App developers](docs/api.md)
149 - [ActivityPub API.md](docs/apub_api_outline.md)
150 - [Goals](docs/goals.md)
151 - [Ranking Algorithm](docs/ranking.md)
155 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
156 - [Support on Patreon](https://www.patreon.com/dessalines).
157 - [Sponsor List](https://dev.lemmy.ml/sponsors).
158 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
159 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
160 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
164 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
166 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`).
170 lang | done | missing
172 de | 87% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,subscribed,expires,recent_comments,nsfw,show_nsfw,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
173 eo | 96% | number_of_communities,preview,upload_image,formatting_help,are_you_sure,yes,no
174 es | 96% | number_of_communities,preview,upload_image,formatting_help,are_you_sure,yes,no
175 fr | 89% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,recent_comments,nsfw,show_nsfw,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
176 nl | 98% | preview,upload_image,formatting_help
177 ru | 91% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,recent_comments,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
178 sv | 98% | preview,upload_image,formatting_help
179 zh | 89% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,recent_comments,nsfw,show_nsfw,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
183 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license