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).
  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 - High performance.
  43   - Server is written in rust.
  44   - Front end is `~80kB` gzipped.
  45
  46 ## About
  47
  48 [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).
  49
  50 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.
  51
  52 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.
  53
  54 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.
  55
  56 ## Why's it called Lemmy?
  57
  58 - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  59 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  60 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  61 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  62
  63 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/).
  64
  65 ## Install
  66
  67 ### Ansible (recommended)
  68
  69 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
  70 eg using `sudo apt install ansible`, or the equivalent for you platform.
  71
  72 Then run the following commands on your local computer:
  73 ```bash
  74 git clone https://github.com/dessalines/lemmy.git
  75 cd lemmy/ansible/
  76 cp inventory.example inventory
  77 nano inventory # enter your server, domain, contact email
  78 ansible-playbook lemmy.yml
  79 ```
  80
  81 ### Manual
  82
  83 Make sure you have both docker and docker-compose installed.
  84
  85 ```
  86 mkdir lemmy/
  87 cd lemmy/
  88 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  89 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/env -O .env
  90 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/nginx.conf
  91 # you need to edit .env and nginx.conf to replace the indicated {{ variables }}
  92 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
  93 docker-compose up -d
  94 ```
  95
  96 and goto http://localhost:8536
  97
  98 ### Nginx Config
  99 ```
 100 location / {
 101   rewrite (\/(user|u|inbox|post|community|c|login|search|sponsors|communities|modlog|home)+) /static/index.html break;
 102   proxy_pass http://0.0.0.0:8536;
 103   proxy_set_header X-Real-IP $remote_addr;
 104   proxy_set_header Host $host;
 105   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 106
 107   # WebSocket support
 108   proxy_http_version 1.1;
 109   proxy_set_header Upgrade $http_upgrade;
 110   proxy_set_header Connection "upgrade";
 111 }
 112 ```
 113
 114 ## Develop
 115
 116 ### Docker Development
 117
 118 ```
 119 git clone https://github.com/dessalines/lemmy
 120 cd lemmy/docker
 121 ./docker_update.sh # This pulls the newest version, builds and runs it
 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 ```
 137  psql -c "create user rrr with password 'rrr' superuser;" -U postgres
 138  psql -c 'create database rrr with owner rrr;' -U postgres
 139 ```
 140
 141 #### Running
 142
 143 ```
 144 git clone https://github.com/dessalines/lemmy
 145 cd lemmy
 146 ./install.sh
 147 # For live coding, where both the front and back end, automagically reload on any save, do:
 148 # cd ui && yarn start
 149 # cd server && cargo watch -x run
 150 ```
 151
 152 ## Documentation
 153
 154 - [Websocket API for App developers](docs/api.md)
 155 - [ActivityPub API.md](docs/apub_api_outline.md)
 156 - [Goals](docs/goals.md)
 157 - [Ranking Algorithm](docs/ranking.md)
 158
 159 ## Support
 160
 161 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 162 - [Support on Patreon](https://www.patreon.com/dessalines).
 163 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 164 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 165 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 166 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 167
 168 ## Translations
 169
 170 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 171
 172 - Languages supported: `en`, `zh`, `fr`, `sv`, `de`, `ru`, `de`
 173
 174 ## Credits
 175
 176 Icon made by Andy Cuccaro (@andycuccaro).