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://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](/RELEASES.md)
  51 - [Contributing](https://dev.lemmy.ml/docs/contributing.html)
  52
  53 ## Repository Mirrors
  54
  55 - GitHub: https://github.com/dessalines/lemmy
  56 - Yerbamate.dev:  https://yerbamate.dev/dessalines/lemmy
  57 - GitLab: https://gitlab.com/dessalines/lemmy
  58
  59 ## Features
  60
  61 - Open source, [AGPL License](/LICENSE).
  62 - Self hostable, easy to deploy.
  63   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  64 - Clean, mobile-friendly interface.
  65   - Only a minimum of a username and password is required to sign up!
  66   - User avatar support.
  67   - Live-updating Comment threads.
  68   - Full vote scores `(+/-)` like old reddit.
  69   - Themes, including light, dark, and solarized.
  70   - Emojis with autocomplete support. Start typing `:`
  71   - User tagging using `@`, Community tagging using `#`.
  72   - Integrated image uploading in both posts and comments.
  73   - A post can consist of a title and any combination of self text, a URL, or nothing else.
  74   - Notifications, on comment replies and when you're tagged.
  75     - Notifications can be sent via email.
  76   - i18n / internationalization support.
  77   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  78 - Cross-posting support.
  79   - A *similar post search* when creating new posts. Great for question / answer communities.
  80 - Moderation abilities.
  81   - Public Moderation Logs.
  82   - Can sticky posts to the top of communities.
  83   - Both site admins, and community moderators, who can appoint other moderators.
  84   - Can lock, remove, and restore posts and comments.
  85   - Can ban and unban users from communities and the site.
  86   - Can transfer site and communities to others.
  87 - Can fully erase your data, replacing all posts and comments.
  88 - NSFW post / community support.
  89 - High performance.
  90   - Server is written in rust.
  91   - Front end is `~80kB` gzipped.
  92   - Supports arm64 / Raspberry Pi.
  93
  94 ## Why's it called Lemmy?
  95
  96 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  97 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  98 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  99 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
 100
 101 ## Install
 102
 103 ### Docker
 104
 105 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
 106
 107 ```bash
 108 mkdir lemmy/
 109 cd lemmy/
 110 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 111 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
 112 # Edit lemmy.hjson to do more configuration
 113 docker-compose up -d
 114 ```
 115
 116 and go to http://localhost:8536.
 117
 118 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
 119
 120 ```bash
 121 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
 122 # Replace the {{ vars }}
 123 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
 124 ```
 125 #### Updating
 126
 127 To update to the newest version, run:
 128
 129 ```bash
 130 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 131 docker-compose up -d
 132 ```
 133
 134 ### Ansible
 135
 136 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.
 137
 138 Then run the following commands on your local computer:
 139
 140 ```bash
 141 git clone https://github.com/dessalines/lemmy.git
 142 cd lemmy/ansible/
 143 cp inventory.example inventory
 144 nano inventory # enter your server, domain, contact email
 145 ansible-playbook lemmy.yml --become
 146 ```
 147
 148 ## Support / Donate
 149
 150 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 151
 152 - [Support on Patreon](https://www.patreon.com/dessalines).
 153 - [List of Sponsors](https://dev.lemmy.ml/sponsors).
 154 - Soon to add either liberapay or opencollective.
 155
 156 ### Crypto
 157
 158 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 159 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 160 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 161
 162 ## Translations
 163
 164 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
 165
 166 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
 167
 168 <!-- translations -->
 169
 170 lang | done | missing
 171 --- | --- | ---
 172 de | 88% | create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,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
 173 eo | 76% | 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,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
 174 es | 83% | create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,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
 175 fr | 83% | create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,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
 176 it | 84% | create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,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
 177 nl | 93% | create_private_message,send_secure_message,send_message,message,message_sent,messages,matrix_user_id,private_message_disclaimer,donate_to_lemmy,donate,from,logged_in,email_already_exists,couldnt_create_private_message,no_private_message_edit_allowed,couldnt_update_private_message
 178 ru | 72% | cross_posts,cross_post,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,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
 179 sv | 83% | create_private_message,send_secure_message,send_message,message,avatar,upload_avatar,show_avatars,archive_link,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
 180 zh | 70% | cross_posts,cross_post,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,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
 181
 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.