README.md

   1 <p align="center">
   2   <a href="https://dev.lemmy.ml/" 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 stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
  11 [![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@LemmyDev)
  12 [![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)
  13 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
  14 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
  15 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  16 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
  17 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  18 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  19 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  20 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
  21 </div>
  22
  23 ---
  24
  25 <p align="center">A link aggregator / reddit clone for the fediverse.
  26     <br>
  27 </p>
  28
  29 [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.*
  30
  31 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
  32
  33 Front Page|Post
  34 ---|---
  35 ![main screen](https://i.imgur.com/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.png)
  36
  37 [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).
  38
  39 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.
  40
  41 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.
  42
  43 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.
  44
  45 Made with [Rust](https://www.rust-lang.org), [Actix](https://actix.rs/), [Inferno](https://infernojs.org), [Typescript](https://www.typescriptlang.org/) and [Diesel](http://diesel.rs/).
  46
  47 - [Documentation](https://dev.lemmy.ml/docs/index.html)
  48 - [Releases / Changelog](/RELEASES.md)
  49 - [Contributing](https://dev.lemmy.ml/docs/contributing.html)
  50
  51 ## Repository Mirrors
  52
  53 - [GitHub](https://github.com/dessalines/lemmy)
  54 - [Gitea](https://yerbamate.dev/dessalines/lemmy)
  55 - [GitLab](https://gitlab.com/dessalines/lemmy)
  56
  57 ## Features
  58
  59 - Open source, [AGPL License](/LICENSE).
  60 - Self hostable, easy to deploy.
  61   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  62 - Clean, mobile-friendly interface.
  63   - Only a minimum of a username and password is required to sign up!
  64   - User avatar support.
  65   - Live-updating Comment threads.
  66   - Full vote scores `(+/-)` like old reddit.
  67   - Themes, including light, dark, and solarized.
  68   - Emojis with autocomplete support. Start typing `:`
  69   - User tagging using `@`, Community tagging using `#`.
  70   - Integrated image uploading in both posts and comments.
  71   - A post can consist of a title and any combination of self text, a URL, or nothing else.
  72   - Notifications, on comment replies and when you're tagged.
  73     - Notifications can be sent via email.
  74   - i18n / internationalization support.
  75   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  76 - Cross-posting support.
  77   - A *similar post search* when creating new posts. Great for question / answer communities.
  78 - Moderation abilities.
  79   - Public Moderation Logs.
  80   - Can sticky posts to the top of communities.
  81   - Both site admins, and community moderators, who can appoint other moderators.
  82   - Can lock, remove, and restore posts and comments.
  83   - Can ban and unban users from communities and the site.
  84   - Can transfer site and communities to others.
  85 - Can fully erase your data, replacing all posts and comments.
  86 - NSFW post / community support.
  87 - High performance.
  88   - Server is written in rust.
  89   - Front end is `~80kB` gzipped.
  90   - Supports arm64 / Raspberry Pi.
  91
  92 ## Why's it called Lemmy?
  93
  94 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  95 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  96 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  97 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  98
  99 ## Install
 100
 101 ### Docker
 102
 103 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
 104
 105 ```bash
 106 mkdir lemmy/
 107 cd lemmy/
 108 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 109 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
 110 # Edit lemmy.hjson to do more configuration
 111 docker-compose up -d
 112 ```
 113
 114 and go to http://localhost:8536.
 115
 116 [A sample nginx config](/ansible/templates/nginx.conf) (Image uploading won't work without this), could be setup with:
 117
 118 ```bash
 119 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
 120 # Replace the {{ vars }}
 121 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
 122 ```
 123 #### Updating
 124
 125 To update to the newest version, run:
 126
 127 ```bash
 128 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 129 docker-compose up -d
 130 ```
 131
 132 ### Ansible
 133
 134 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.
 135
 136 Then run the following commands on your local computer:
 137
 138 ```bash
 139 git clone https://github.com/dessalines/lemmy.git
 140 cd lemmy/ansible/
 141 cp inventory.example inventory
 142 nano inventory # enter your server, domain, contact email
 143 ansible-playbook lemmy.yml --become
 144 ```
 145
 146 ## Support / Donate
 147
 148 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 149
 150 - [Support on Patreon](https://www.patreon.com/dessalines).
 151 - [List of Sponsors](https://dev.lemmy.ml/sponsors).
 152 - Soon to add either liberapay or opencollective.
 153
 154 ### Crypto
 155
 156 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 157 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 158 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 159
 160 ## Translations
 161
 162 If you'd like to add translations, take a look at the [English translation file](ui/src/translations/en.ts).
 163
 164 - Languages supported: 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`).
 165
 166 <!-- translations -->
 167
 168 lang | done | missing
 169 ---- | ---- | -------
 170 ca | 98% | cross_posted_to,old,time,action
 171 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,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 172 fa | 72% | 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,general_sponsors,joined,by,to,from,landing_0,logged_in,community_moderator_already_exists,community_follower_already_exists,community_user_already_banned,no_slurs,admin_already_created,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 173 eo | 74% | 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,donate_to_lemmy,donate,from,are_you_sure,yes,no,logged_in,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 174 es | 100% | cross_posted_to
 175 fi | 98% | cross_posted_to,old,time,action
 176 fr | 82% | 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,donate_to_lemmy,donate,from,logged_in,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 177 it | 83% | 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,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 178 nl | 99% | cross_posted_to,time,action
 179 ru | 71% | 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,donate_to_lemmy,donate,monero,by,to,from,transfer_community,transfer_site,are_you_sure,yes,no,logged_in,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 180 sv | 82% | 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,donate_to_lemmy,donate,from,logged_in,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 181 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,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message,time,action
 182 <!-- translationsstop -->
 183
 184 If you'd like to update this report, run:
 185
 186 ```bash
 187 cd ui
 188 ts-node translation_report.ts
 189 ```
 190
 191 ## Credits
 192
 193 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.