2019-10-22 06:24:06 +00:00
< p align = "center" >
< a href = "" rel = "noopener" >
2019-10-22 06:24:57 +00:00
< img width = 200px height = 200px src = "ui/assets/favicon.svg" > < / a >
2019-10-22 06:24:06 +00:00
< / p >
< h3 align = "center" > Lemmy< / h3 >
< div align = "center" >
2019-02-14 17:36:53 +00:00
2019-08-16 20:08:37 +00:00
[![Github ](https://img.shields.io/badge/-Github-blue )](https://github.com/dessalines/lemmy)
[![Gitlab ](https://img.shields.io/badge/-Gitlab-yellowgreen )](https://gitlab.com/dessalines/lemmy)
2019-12-31 16:07:57 +00:00
[![Mastodon Follow ](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social )](https://mastodon.social/@LemmyDev)
2019-09-13 05:19:52 +00:00
![GitHub stars ](https://img.shields.io/github/stars/dessalines/lemmy?style=social )
[![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)
2019-05-14 19:43:35 +00:00
![GitHub tag (latest SemVer) ](https://img.shields.io/github/tag/dessalines/lemmy.svg )
2019-04-06 15:32:34 +00:00
[![Build Status ](https://travis-ci.org/dessalines/lemmy.svg?branch=master )](https://travis-ci.org/dessalines/lemmy)
2019-04-06 20:03:44 +00:00
[![GitHub issues ](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg )](https://github.com/dessalines/lemmy/issues)
2019-09-13 05:19:52 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/dessalines/lemmy.svg )](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
2019-05-14 19:43:35 +00:00
![GitHub commit activity ](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg )
2019-09-13 05:19:52 +00:00
![GitHub repo size ](https://img.shields.io/github/repo-size/dessalines/lemmy.svg )
2019-05-14 19:43:35 +00:00
[![License ](https://img.shields.io/github/license/dessalines/lemmy.svg )](LICENSE)
2019-04-22 20:35:51 +00:00
[![Patreon ](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg )](https://www.patreon.com/dessalines)
2019-10-22 06:24:06 +00:00
< / div >
---
2019-04-06 15:32:34 +00:00
2019-10-22 06:24:06 +00:00
< p align = "center" > A link aggregator / reddit clone for the fediverse.
< br >
< / p >
2019-02-14 17:36:53 +00:00
2020-01-17 18:30:26 +00:00
[Lemmy Dev instance ](https://dev.lemmy.ml ) *This data is being backed up, and once federation is working, it will be the basis for a main instance.*
2019-02-15 01:42:04 +00:00
2019-04-22 20:35:51 +00:00
This is a **very early beta version** , and a lot of features are currently broken or in active development, such as federation.
2019-04-27 00:56:33 +00:00
2019-05-04 15:58:53 +00:00
Front Page|Post
---|---
2019-11-02 16:47:07 +00:00
![main screen ](https://i.imgur.com/kZSRcRu.png )|![chat screen](https://i.imgur.com/4XghNh6.png)
2019-10-18 03:20:59 +00:00
2019-04-22 20:55:29 +00:00
[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 ).
2019-04-22 20:35:51 +00:00
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.
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.
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.
2019-05-04 15:58:53 +00:00
2020-01-01 22:47:00 +00:00
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/ ).
2020-01-17 22:52:48 +00:00
- [Documentation ](https://dev.lemmy.ml/docs/index.html )
- [Releases / Changelog ](/CHANGELOG )
- [Contributing ](https://dev.lemmy.ml/docs/contributing.html )
2020-01-01 22:47:00 +00:00
## Features
- Open source, [AGPL License ](/LICENSE ).
- Self hostable, easy to deploy.
- Comes with [Docker ](#docker ), [Ansible ](#ansible ), [Kubernetes ](#kubernetes ).
- Clean, mobile-friendly interface.
- Live-updating Comment threads.
- Full vote scores `(+/-)` like old reddit.
- Themes, including light, dark, and solarized.
- Emojis with autocomplete support. Start typing `:`
- User tagging using `@` , Community tagging using `#` .
- Notifications, on comment replies and when you're tagged.
- i18n / internationalization support.
- RSS / Atom feeds for `All` , `Subscribed` , `Inbox` , `User` , and `Community` .
- Cross-posting support.
- A *similar post search* when creating new posts. Great for question / answer communities.
- Moderation abilities.
- Public Moderation Logs.
- Both site admins, and community moderators, who can appoint other moderators.
- Can lock, remove, and restore posts and comments.
- Can ban and unban users from communities and the site.
- Can transfer site and communities to others.
- Can fully erase your data, replacing all posts and comments.
- NSFW post / community support.
- High performance.
- Server is written in rust.
- Front end is `~80kB` gzipped.
- Supports arm64 / Raspberry Pi.
## Why's it called Lemmy?
- Lead singer from [Motörhead ](https://invidio.us/watch?v=pWB5JZRGl0U ).
- The old school [video game ](<https://en.wikipedia.org/wiki/Lemmings_(video_game )>).
- The [Koopa from Super Mario ](https://www.mariowiki.com/Lemmy_Koopa ).
- The [furry rodents ](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/ ).
2019-10-22 06:26:46 +00:00
## Install
2019-08-10 00:28:34 +00:00
2019-08-20 23:20:46 +00:00
### Docker
2019-08-20 17:43:30 +00:00
2019-10-20 19:31:15 +00:00
Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
2019-08-15 16:36:34 +00:00
2019-08-22 04:09:46 +00:00
```bash
2019-08-15 21:21:27 +00:00
mkdir lemmy/
cd lemmy/
2019-08-16 01:05:49 +00:00
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
2019-12-28 21:06:37 +00:00
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
2019-12-31 16:07:57 +00:00
# Edit lemmy.hjson to do more configuration
2019-05-14 19:05:43 +00:00
docker-compose up -d
```
2019-10-20 19:31:15 +00:00
and go to http://localhost:8536.
2019-07-15 02:43:31 +00:00
2019-09-07 16:37:12 +00:00
[A sample nginx config ](/ansible/templates/nginx.conf ), could be setup with:
2019-08-20 23:20:46 +00:00
2019-08-22 04:09:46 +00:00
```bash
2019-09-07 16:37:12 +00:00
wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
2019-08-20 23:20:46 +00:00
# Replace the {{ vars }}
sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
```
2019-09-07 16:37:12 +00:00
#### Updating
To update to the newest version, run:
```bash
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
docker-compose up -d
```
2019-08-20 23:20:46 +00:00
### Ansible
2019-10-20 19:31:15 +00:00
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.
2019-08-20 23:20:46 +00:00
Then run the following commands on your local computer:
```bash
git clone https://github.com/dessalines/lemmy.git
cd lemmy/ansible/
cp inventory.example inventory
nano inventory # enter your server, domain, contact email
2019-09-04 19:54:23 +00:00
ansible-playbook lemmy.yml --become
2019-07-15 02:43:31 +00:00
```
2019-10-22 06:26:46 +00:00
## Support
2019-08-10 00:28:34 +00:00
2019-04-24 16:28:20 +00:00
Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
2019-10-21 20:05:13 +00:00
2019-04-24 16:28:20 +00:00
- [Support on Patreon ](https://www.patreon.com/dessalines ).
2019-07-15 02:43:31 +00:00
- [Sponsor List ](https://dev.lemmy.ml/sponsors ).
2019-05-17 15:32:07 +00:00
- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
2019-04-17 00:32:13 +00:00
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
2019-08-20 21:47:19 +00:00
- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
2019-08-10 00:28:34 +00:00
## Translations
2019-10-20 19:31:15 +00:00
If you'd like to add translations, take a look a look at the [English translation file ](ui/src/translations/en.ts ).
2019-08-10 00:28:34 +00:00
2019-10-21 07:02:20 +00:00
- Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
2019-08-10 00:28:34 +00:00
2019-08-25 00:58:55 +00:00
lang | done | missing
2019-08-24 04:43:12 +00:00
--- | --- | ---
2020-01-14 22:02:42 +00:00
de | 95% | avatar,upload_avatar,show_avatars,docs,old_password,send_notifications_to_email,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
eo | 82% | number_of_communities,preview,upload_image,avatar,upload_avatar,show_avatars,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme,are_you_sure,yes,no
es | 90% | avatar,upload_avatar,show_avatars,archive_link,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
fr | 90% | avatar,upload_avatar,show_avatars,archive_link,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
it | 91% | avatar,upload_avatar,show_avatars,archive_link,docs,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
2020-01-17 18:30:26 +00:00
nl | 100% |
2020-01-14 22:02:42 +00:00
ru | 78% | cross_posts,cross_post,number_of_communities,preview,upload_image,avatar,upload_avatar,show_avatars,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,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
sv | 90% | avatar,upload_avatar,show_avatars,archive_link,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
zh | 76% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,avatar,upload_avatar,show_avatars,formatting_help,view_source,sticky,unsticky,archive_link,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,docs,replies,mentions,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,send_notifications_to_email,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
2019-08-25 00:58:55 +00:00
2020-01-17 18:30:26 +00:00
2019-10-18 19:13:09 +00:00
If you'd like to update this report, run:
```bash
cd ui
ts-node translation_report.ts > tmp # And replace the text above.
```
2019-04-06 22:49:51 +00:00
## Credits
2019-08-10 00:28:34 +00:00
2019-10-20 19:31:15 +00:00
Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.