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)](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)
  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) *This data is being backed up, and once federation is working, it will be the basis for a main instance.*
  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 [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).
  40
  41 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.
  42
  43 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.
  44
  45 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.
  46
  47 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/).
  48
  49 - [Documentation](https://dev.lemmy.ml/docs/index.html)
  50 - [Releases / Changelog](/CHANGELOG)
  51 - [Contributing](https://dev.lemmy.ml/docs/contributing.html)
  52
  53 ## Features
  54
  55 - Open source, [AGPL License](/LICENSE).
  56 - Self hostable, easy to deploy.
  57   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  58 - Clean, mobile-friendly interface.
  59   - Live-updating Comment threads.
  60   - Full vote scores `(+/-)` like old reddit.
  61   - Themes, including light, dark, and solarized.
  62   - Emojis with autocomplete support. Start typing `:`
  63   - User tagging using `@`, Community tagging using `#`.
  64   - Notifications, on comment replies and when you're tagged.
  65   - i18n / internationalization support.
  66   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  67 - Cross-posting support.
  68   - A *similar post search* when creating new posts. Great for question / answer communities.
  69 - Moderation abilities.
  70   - Public Moderation Logs.
  71   - Both site admins, and community moderators, who can appoint other moderators.
  72   - Can lock, remove, and restore posts and comments.
  73   - Can ban and unban users from communities and the site.
  74   - Can transfer site and communities to others.
  75 - Can fully erase your data, replacing all posts and comments.
  76 - NSFW post / community support.
  77 - High performance.
  78   - Server is written in rust.
  79   - Front end is `~80kB` gzipped.
  80   - Supports arm64 / Raspberry Pi.
  81
  82 ## Why's it called Lemmy?
  83
  84 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  85 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  86 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  87 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  88
  89 ## Install
  90
  91 ### Docker
  92
  93 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
  94
  95 ```bash
  96 mkdir lemmy/
  97 cd lemmy/
  98 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  99 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
 100 # Edit lemmy.hjson to do more configuration
 101 docker-compose up -d
 102 ```
 103
 104 and go to http://localhost:8536.
 105
 106 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
 107
 108 ```bash
 109 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
 110 # Replace the {{ vars }}
 111 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
 112 ```
 113 #### Updating
 114
 115 To update to the newest version, run:
 116
 117 ```bash
 118 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 119 docker-compose up -d
 120 ```
 121
 122 ### Ansible
 123
 124 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.
 125
 126 Then run the following commands on your local computer:
 127
 128 ```bash
 129 git clone https://github.com/dessalines/lemmy.git
 130 cd lemmy/ansible/
 131 cp inventory.example inventory
 132 nano inventory # enter your server, domain, contact email
 133 ansible-playbook lemmy.yml --become
 134 ```
 135
 136 ## Support
 137
 138 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 139
 140 - [Support on Patreon](https://www.patreon.com/dessalines).
 141 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 142 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 143 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 144 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 145
 146 ## Translations
 147
 148 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
 149
 150 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
 151
 152 lang | done | missing
 153 --- | --- | ---
 154 de | 95% | avatar,upload_avatar,show_avatars,docs,old_password,send_notifications_to_email,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw
 155 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
 156 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
 157 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
 158 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
 159 nl | 100% |
 160 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
 161 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
 162 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
 163
 164
 165 If you'd like to update this report, run:
 166
 167 ```bash
 168 cd ui
 169 ts-node translation_report.ts > tmp # And replace the text above.
 170 ```
 171
 172 ## Credits
 173
 174 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.