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 - 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 ### Docker
  68
  69 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
  70
  71 ```bash
  72 mkdir lemmy/
  73 cd lemmy/
  74 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  75 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
  76 # Edit the .env if you want custom passwords
  77 docker-compose up -d
  78 ```
  79
  80 and goto http://localhost:8536
  81
  82 [A sample nginx config](/docker/prod/nginx.conf), could be setup with:
  83
  84 ```bash
  85 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/nginx.conf
  86 # Replace the {{ vars }}
  87 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
  88 ```
  89
  90 ### Ansible
  91
  92 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
  93 eg using `sudo apt install ansible`, or the equivalent for you platform.
  94
  95 Then run the following commands on your local computer:
  96
  97 ```bash
  98 git clone https://github.com/dessalines/lemmy.git
  99 cd lemmy/ansible/
 100 cp inventory.example inventory
 101 nano inventory # enter your server, domain, contact email
 102 ansible-playbook lemmy.yml
 103 ```
 104
 105 ## Develop
 106
 107 ### Docker Development
 108
 109 ```bash
 110 git clone https://github.com/dessalines/lemmy
 111 cd lemmy/docker/dev
 112 ./docker_update.sh # This builds and runs it, updating for your changes
 113 ```
 114
 115 and goto http://localhost:8536
 116
 117 ### Local Development
 118
 119 #### Requirements
 120
 121 - [Rust](https://www.rust-lang.org/)
 122 - [Yarn](https://yarnpkg.com/en/)
 123 - [Postgres](https://www.postgresql.org/)
 124
 125 #### Set up Postgres DB
 126
 127 ```bash
 128  psql -c "create user lemmy with password 'password' superuser;" -U postgres
 129  psql -c 'create database lemmy with owner lemmy;' -U postgres
 130  export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
 131 ```
 132
 133 #### Running
 134
 135 ```bash
 136 git clone https://github.com/dessalines/lemmy
 137 cd lemmy
 138 ./install.sh
 139 # For live coding, where both the front and back end, automagically reload on any save, do:
 140 # cd ui && yarn start
 141 # cd server && cargo watch -x run
 142 ```
 143
 144 ## Documentation
 145
 146 - [Websocket API for App developers](docs/api.md)
 147 - [ActivityPub API.md](docs/apub_api_outline.md)
 148 - [Goals](docs/goals.md)
 149 - [Ranking Algorithm](docs/ranking.md)
 150
 151 ## Support
 152
 153 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 154 - [Support on Patreon](https://www.patreon.com/dessalines).
 155 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 156 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 157 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 158 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 159
 160 ## Translations
 161
 162 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 163
 164 - Languages supported: English (`en`), Chinese (`zh`), French (`fr`), Swedish (`sv`), German (`de`), Russian (`ru`).
 165
 166 ## Credits
 167
 168 Icon made by Andy Cuccaro (@andycuccaro).