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