README.md

   1 <h1><img src="ui/assets/favicon.svg" width="50px" height="50px" style="vertical-align:bottom" /><span>Lemmy</span></h1>
   2
   3 [![Github](https://img.shields.io/badge/-Github-blue)](https://github.com/dessalines/lemmy)
   4 [![Gitlab](https://img.shields.io/badge/-Gitlab-yellowgreen)](https://gitlab.com/dessalines/lemmy)
   5 ![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)
   6 ![GitHub stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
   7 [![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)
   8 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
   9 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
  10 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  11 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
  12 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  13 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  14 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  15 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
  16
  17 A link aggregator / reddit clone for the fediverse.
  18
  19 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
  20
  21 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
  22
  23 Front Page|Post
  24 ---|---
  25 ![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png)
  26 ## Features
  27
  28 - Open source, [AGPL License](/LICENSE).
  29 - Self hostable, easy to deploy.
  30   - Comes with [Docker](#docker), [Ansible](#ansible).
  31 - Live-updating Comment threads.
  32 - Full vote scores `(+/-)` like old reddit.
  33 - Moderation abilities.
  34   - Public Moderation Logs.
  35   - Both site admins, and community moderators, who can appoint other moderators.
  36   - Can lock, remove, and restore posts and comments.
  37   - Can ban and unban users from communities and the site.
  38 - Clean, mobile-friendly interface.
  39 - i18n / internationalization support.
  40 - NSFW post / community support.
  41 - Cross-posting support.
  42 - Can transfer site and communities to others.
  43 - High performance.
  44   - Server is written in rust.
  45   - Front end is `~80kB` gzipped.
  46
  47 ## About
  48
  49 [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).
  50
  51 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.
  52
  53 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.
  54
  55 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.
  56
  57 ## Why's it called Lemmy?
  58
  59 - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  60 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  61 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  62 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  63
  64 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/).
  65
  66 ## Install
  67
  68 ### Docker
  69
  70 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
  71
  72 ```bash
  73 mkdir lemmy/
  74 cd lemmy/
  75 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  76 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
  77 # Edit the .env if you want custom passwords
  78 docker-compose up -d
  79 ```
  80
  81 and goto http://localhost:8536
  82
  83 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
  84
  85 ```bash
  86 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
  87 # Replace the {{ vars }}
  88 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
  89 ```
  90 #### Updating
  91
  92 To update to the newest version, run:
  93
  94 ```bash
  95 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  96 docker-compose up -d
  97 ```
  98
  99 ### Ansible
 100
 101 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
 102 eg using `sudo apt install ansible`, or the equivalent for you platform.
 103
 104 Then run the following commands on your local computer:
 105
 106 ```bash
 107 git clone https://github.com/dessalines/lemmy.git
 108 cd lemmy/ansible/
 109 cp inventory.example inventory
 110 nano inventory # enter your server, domain, contact email
 111 ansible-playbook lemmy.yml --become
 112 ```
 113
 114 ## Develop
 115
 116 ### Docker Development
 117
 118 ```bash
 119 git clone https://github.com/dessalines/lemmy
 120 cd lemmy/docker/dev
 121 ./docker_update.sh # This builds and runs it, updating for your changes
 122 ```
 123
 124 and goto http://localhost:8536
 125
 126 ### Local Development
 127
 128 #### Requirements
 129
 130 - [Rust](https://www.rust-lang.org/)
 131 - [Yarn](https://yarnpkg.com/en/)
 132 - [Postgres](https://www.postgresql.org/)
 133
 134 #### Set up Postgres DB
 135
 136 ```bash
 137  psql -c "create user lemmy with password 'password' superuser;" -U postgres
 138  psql -c 'create database lemmy with owner lemmy;' -U postgres
 139  export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
 140 ```
 141
 142 #### Running
 143
 144 ```bash
 145 git clone https://github.com/dessalines/lemmy
 146 cd lemmy
 147 ./install.sh
 148 # For live coding, where both the front and back end, automagically reload on any save, do:
 149 # cd ui && yarn start
 150 # cd server && cargo watch -x run
 151 ```
 152
 153 ## Documentation
 154
 155 - [Websocket API for App developers](docs/api.md)
 156 - [ActivityPub API.md](docs/apub_api_outline.md)
 157 - [Goals](docs/goals.md)
 158 - [Ranking Algorithm](docs/ranking.md)
 159
 160 ## Support
 161
 162 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 163 - [Support on Patreon](https://www.patreon.com/dessalines).
 164 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 165 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 166 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 167 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 168
 169 ## Translations
 170
 171 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 172
 173 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`).
 174
 175 ### Report
 176
 177 lang | done | missing
 178 --- | --- | ---
 179 de | 84% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,banned,subscribed,expires,recent_comments,nsfw,show_nsfw,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 180 eo | 93% | number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,banned,are_you_sure,yes,no
 181 es | 100% |
 182 fr | 98% | view_source,sticky,unsticky,stickied
 183 nl | 96% | preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,banned
 184 ru | 89% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,banned,recent_comments,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 185 sv | 96% | preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,banned
 186 zh | 87% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,banned,recent_comments,nsfw,show_nsfw,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 187
 188 ## Credits
 189
 190 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license