README.md

   1 <h1><img src="https://image.flaticon.com/icons/svg/194/194242.svg" width="50px" height="50px" /> Lemmy</h1>
   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 ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/dessalines/lemmy.svg)
   6 [![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
   7 [![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
   8 ![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)
   9 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  10 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  11 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  12 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  13 [![Mastodon](https://img.shields.io/badge/Mastodon-follow-lightgrey.svg)](https://mastodon.social/@LemmyDev)
  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 [![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).
  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 - High performance.
  41   - Server is written in rust.
  42   - Front end is `~80kB` gzipped.
  43
  44 ## About
  45
  46 [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).
  47
  48 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.
  49
  50 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.
  51
  52 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.
  53
  54 ## Why's it called Lemmy?
  55
  56 - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  57 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  58 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  59 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  60
  61 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/).
  62
  63 ## Install
  64
  65 ### Docker
  66
  67 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
  68
  69 ```
  70 mkdir lemmy/
  71 cd lemmy/
  72 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/docker-compose.yml
  73 docker-compose up -d
  74 ```
  75
  76 and goto http://localhost:8536
  77
  78 ### Nginx Config
  79 ```
  80 location / {
  81   rewrite (\/(user|u|inbox|post|community|c|login|search|sponsors|communities|modlog|home)+) /static/index.html break;
  82   proxy_pass http://0.0.0.0:8536;
  83   proxy_set_header X-Real-IP $remote_addr;
  84   proxy_set_header Host $host;
  85   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  86
  87   # WebSocket support
  88   proxy_http_version 1.1;
  89   proxy_set_header Upgrade $http_upgrade;
  90   proxy_set_header Connection "upgrade";
  91 }
  92 ```
  93
  94 ## Develop
  95
  96 ### Docker Development
  97
  98 ```
  99 git clone https://github.com/dessalines/lemmy
 100 cd lemmy
 101 ./docker_update.sh # This pulls the newest version, builds and runs it
 102 ```
 103
 104 and goto http://localhost:8536
 105
 106 ### Local Development
 107
 108 #### Requirements
 109
 110 - [Rust](https://www.rust-lang.org/)
 111 - [Yarn](https://yarnpkg.com/en/)
 112 - [Postgres](https://www.postgresql.org/)
 113
 114 #### Set up Postgres DB
 115
 116 ```
 117  psql -c "create user rrr with password 'rrr' superuser;" -U postgres
 118  psql -c 'create database rrr with owner rrr;' -U postgres
 119 ```
 120
 121 #### Running
 122
 123 ```
 124 git clone https://github.com/dessalines/lemmy
 125 cd lemmy
 126 ./install.sh
 127 # For live coding, where both the front and back end, automagically reload on any save, do:
 128 # cd ui && yarn start
 129 # cd server && cargo watch -x run
 130 ```
 131
 132 ## Documentation
 133
 134 - [Websocket API for App developers](docs/api.md)
 135 - [ActivityPub API.md](docs/apub_api_outline.md)
 136 - [Goals](docs/goals.md)
 137 - [Ranking Algorithm](docs/ranking.md)
 138
 139 ## Support
 140
 141 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 142 - [Support on Patreon](https://www.patreon.com/dessalines).
 143 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 144 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 145 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 146
 147 ## Translations
 148
 149 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 150
 151 - Languages supported: `en`, `zh`, `fr`, `sv`
 152
 153 ## Credits
 154
 155 Icons made by [Freepik](https://www.freepik.com/) licensed by [CC 3.0](http://creativecommons.org/licenses/by/3.0/)