README.md

   1 <h1><img src="ui/assets/favicon.svg" width="50px" height="50px" 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 ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/dessalines/lemmy.svg)
   8 [![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
   9 [![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
  10 ![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)
  11 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  12 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  13 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  14 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  15 [![Mastodon](https://img.shields.io/badge/Mastodon-follow-lightgrey.svg)](https://mastodon.social/@LemmyDev)
  16 [![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)
  17 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
  18
  19 A link aggregator / reddit clone for the fediverse.
  20
  21 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
  22
  23 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
  24
  25 Front Page|Post
  26 ---|---
  27 ![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png)
  28 ## Features
  29
  30 - Open source, [AGPL License](/LICENSE).
  31 - Self hostable, easy to deploy.
  32   - Comes with [Docker](#docker).
  33 - Live-updating Comment threads.
  34 - Full vote scores `(+/-)` like old reddit.
  35 - Moderation abilities.
  36   - Public Moderation Logs.
  37   - Both site admins, and community moderators, who can appoint other moderators.
  38   - Can lock, remove, and restore posts and comments.
  39   - Can ban and unban users from communities and the site.
  40 - Clean, mobile-friendly interface.
  41 - i18n / internationalization support.
  42 - NSFW post / community support.
  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 ```
  73 mkdir lemmy/
  74 cd lemmy/
  75 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  76 docker-compose up -d
  77 ```
  78
  79 and goto http://localhost:8536
  80
  81 ### Nginx Config
  82 ```
  83 location / {
  84   rewrite (\/(user|u|inbox|post|community|c|login|search|sponsors|communities|modlog|home)+) /static/index.html break;
  85   proxy_pass http://0.0.0.0:8536;
  86   proxy_set_header X-Real-IP $remote_addr;
  87   proxy_set_header Host $host;
  88   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  89
  90   # WebSocket support
  91   proxy_http_version 1.1;
  92   proxy_set_header Upgrade $http_upgrade;
  93   proxy_set_header Connection "upgrade";
  94 }
  95 ```
  96
  97 ## Develop
  98
  99 ### Docker Development
 100
 101 ```
 102 git clone https://github.com/dessalines/lemmy
 103 cd lemmy/docker
 104 ./docker_update.sh # This pulls the newest version, builds and runs it
 105 ```
 106
 107 and goto http://localhost:8536
 108
 109 ### Local Development
 110
 111 #### Requirements
 112
 113 - [Rust](https://www.rust-lang.org/)
 114 - [Yarn](https://yarnpkg.com/en/)
 115 - [Postgres](https://www.postgresql.org/)
 116
 117 #### Set up Postgres DB
 118
 119 ```
 120  psql -c "create user rrr with password 'rrr' superuser;" -U postgres
 121  psql -c 'create database rrr with owner rrr;' -U postgres
 122 ```
 123
 124 #### Running
 125
 126 ```
 127 git clone https://github.com/dessalines/lemmy
 128 cd lemmy
 129 ./install.sh
 130 # For live coding, where both the front and back end, automagically reload on any save, do:
 131 # cd ui && yarn start
 132 # cd server && cargo watch -x run
 133 ```
 134
 135 ## Documentation
 136
 137 - [Websocket API for App developers](docs/api.md)
 138 - [ActivityPub API.md](docs/apub_api_outline.md)
 139 - [Goals](docs/goals.md)
 140 - [Ranking Algorithm](docs/ranking.md)
 141
 142 ## Support
 143
 144 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 145 - [Support on Patreon](https://www.patreon.com/dessalines).
 146 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 147 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 148 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 149
 150 ## Translations
 151
 152 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 153
 154 - Languages supported: `en`, `zh`, `fr`, `sv`
 155
 156 ## Credits
 157
 158 Icon made by Andy Cuccaro (@andycuccaro).