README.md

   1 <div align="center">
   2
   3 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
   4 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
   5 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
   6 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
   7 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
   8 ![GitHub stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
   9 </div>
  10
  11 <p align="center">
  12   <a href="https://dev.lemmy.ml/" rel="noopener">
  13  <img width=200px height=200px src="ui/assets/favicon.svg"></a>
  14
  15  <h3 align="center"><a href="https://dev.lemmy.ml">Lemmy</a></h3>
  16   <p align="center">
  17     A link aggregator / reddit clone for the fediverse.
  18     <br />
  19     <br />
  20     <a href="https://dev.lemmy.ml">View Site</a>
  21     ·
  22     <a href="https://dev.lemmy.ml/docs/index.html">Documentation</a>
  23     ·
  24     <a href="https://github.com/dessalines/lemmy/issues">Report Bug</a>
  25     ·
  26     <a href="https://github.com/dessalines/lemmy/issues">Request Feature</a>
  27     ·
  28     <a href="https://github.com/dessalines/lemmy/blob/master/RELEASES.md">Releases</a>
  29   </p>
  30 </p>
  31
  32 ## About The Project
  33
  34 Front Page|Post
  35 ---|---
  36 ![main screen](https://i.imgur.com/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.png)
  37
  38 [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).
  39
  40 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.
  41
  42 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.
  43
  44 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.
  45
  46 *Note: Federation is still in active development*
  47
  48 ### Why's it called Lemmy?
  49
  50 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  51 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  52 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  53 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  54
  55 ### Built With
  56
  57 - [Rust](https://www.rust-lang.org)
  58 - [Actix](https://actix.rs/)
  59 - [Diesel](http://diesel.rs/)
  60 - [Inferno](https://infernojs.org)
  61 - [Typescript](https://www.typescriptlang.org/)
  62
  63 ## Features
  64
  65 - Open source, [AGPL License](/LICENSE).
  66 - Self hostable, easy to deploy.
  67   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  68 - Clean, mobile-friendly interface.
  69   - Only a minimum of a username and password is required to sign up!
  70   - User avatar support.
  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   - Integrated image uploading in both posts and comments.
  77   - A post can consist of a title and any combination of self text, a URL, or nothing else.
  78   - Notifications, on comment replies and when you're tagged.
  79     - Notifications can be sent via email.
  80   - i18n / internationalization support.
  81   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  82 - Cross-posting support.
  83   - A *similar post search* when creating new posts. Great for question / answer communities.
  84 - Moderation abilities.
  85   - Public Moderation Logs.
  86   - Can sticky posts to the top of communities.
  87   - Both site admins, and community moderators, who can appoint other moderators.
  88   - Can lock, remove, and restore posts and comments.
  89   - Can ban and unban users from communities and the site.
  90   - Can transfer site and communities to others.
  91 - Can fully erase your data, replacing all posts and comments.
  92 - NSFW post / community support.
  93 - OEmbed support via Iframely.
  94 - High performance.
  95   - Server is written in rust.
  96   - Front end is `~80kB` gzipped.
  97   - Supports arm64 / Raspberry Pi.
  98
  99 ## Installation
 100
 101 - [Docker](https://dev.lemmy.ml/docs/administration_install_docker.html)
 102 - [Ansible](https://dev.lemmy.ml/docs/administration_install_ansible.html)
 103 - [Kubernetes](https://dev.lemmy.ml/docs/administration_install_kubernetes.html)
 104 ## Support / Donate
 105
 106 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 107
 108 - [Support on Liberapay.](https://liberapay.com/Lemmy)
 109 - [Support on Patreon](https://www.patreon.com/dessalines).
 110 - [List of Sponsors](https://dev.lemmy.ml/sponsors).
 111
 112 ### Crypto
 113
 114 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 115 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 116 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 117
 118 ## Contributing
 119
 120 - [Contributing instructions](https://dev.lemmy.ml/docs/contributing.html)
 121 - [Docker Development](https://dev.lemmy.ml/docs/contributing_docker_development.html)
 122 - [Local Development](https://dev.lemmy.ml/docs/contributing_local_development.html)
 123
 124 ### Translations
 125
 126 If you'd like to add translations, take a look at the [English translation file](ui/src/translations/en.ts).
 127
 128 - Languages supported: Brazilian Portuguese (`pt-br`), Catalan, (`ca`), Farsi (`fa`), English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), Finnish (`fi`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
 129
 130 <!-- translations -->
 131
 132 lang | done | missing
 133 ---- | ---- | -------
 134 ca | 97% | cross_posted_to,old,support_on_liberapay,couldnt_get_comments,post_title_too_long,time,action
 135 de | 86% | cross_posted_to,create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,old,docs,message_sent,messages,old_password,matrix_user_id,private_message_disclaimer,send_notifications_to_email,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,donate_to_lemmy,donate,from,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 136 fa | 71% | cross_post,cross_posted_to,subscribed_to_communities,trending_communities,create_private_message,send_secure_message,send_message,message,mod,mods,moderates,remove_as_mod,appoint_as_mod,modlog,stickied,ban,ban_from_site,unban,unban_from_site,banned,number_of_subscribers,subscribers,both,saved,unsubscribe,subscribe,subscribed,old,api,docs,inbox,inbox_for,message_sent,notifications_error,messages,no_email_setup,matrix_user_id,private_message_disclaimer,url,body,copy_suggested_title,community,expand_here,subscribe_to_communities,theme,sponsor_message,support_on_liberapay,general_sponsors,joined,by,to,from,landing_0,logged_in,couldnt_get_comments,community_moderator_already_exists,community_follower_already_exists,community_user_already_banned,post_title_too_long,no_slurs,admin_already_created,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 137 eo | 73% | cross_posted_to,number_of_communities,create_private_message,send_secure_message,send_message,message,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,old,docs,replies,mentions,message_sent,messages,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,matrix_user_id,private_message_disclaimer,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme,support_on_liberapay,donate_to_lemmy,donate,from,are_you_sure,yes,no,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 138 es | 99% | cross_posted_to,couldnt_get_comments,post_title_too_long
 139 fi | 97% | cross_posted_to,old,support_on_liberapay,couldnt_get_comments,post_title_too_long,time,action
 140 fr | 100% | upload_avatar,show_avatars
 141 it | 82% | cross_posted_to,create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,old,docs,message_sent,messages,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,matrix_user_id,private_message_disclaimer,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,donate_to_lemmy,donate,from,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 142 nl | 98% | cross_posted_to,couldnt_get_comments,post_title_too_long,time,action
 143 pt-br | 99% | couldnt_get_comments,post_title_too_long
 144 ru | 70% | cross_posts,cross_post,cross_posted_to,number_of_communities,create_private_message,send_secure_message,send_message,message,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,old,docs,replies,mentions,message_sent,messages,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,matrix_user_id,private_message_disclaimer,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,theme,support_on_liberapay,donate_to_lemmy,donate,monero,by,to,from,transfer_community,transfer_site,are_you_sure,yes,no,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 145 sv | 81% | cross_posted_to,create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,old,docs,replies,mentions,message_sent,messages,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,matrix_user_id,private_message_disclaimer,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,support_on_liberapay,donate_to_lemmy,donate,from,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 146 zh | 69% | cross_posts,cross_post,cross_posted_to,users,number_of_communities,create_private_message,send_secure_message,send_message,message,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,old,docs,replies,mentions,message_sent,messages,old_password,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,matrix_user_id,private_message_disclaimer,send_notifications_to_email,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,nsfw,show_nsfw,theme,donate_to_lemmy,donate,monero,by,to,from,transfer_community,transfer_site,are_you_sure,yes,no,logged_in,couldnt_get_comments,post_title_too_long,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 147 <!-- translationsstop -->
 148
 149 If you'd like to update this report, run:
 150
 151 ```bash
 152 cd ui
 153 ts-node translation_report.ts
 154 ```
 155
 156 ## Contact
 157
 158 - [Mastodon](https://mastodon.social/@LemmyDev) - [![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@LemmyDev)
 159 - [Matrix](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org) - [![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)
 160 - [GitHub](https://github.com/dessalines/lemmy)
 161 - [Gitea](https://yerbamate.dev/dessalines/lemmy)
 162 - [GitLab](https://gitlab.com/dessalines/lemmy)
 163
 164 ## Credits
 165
 166 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.