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