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 ![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)
   6 ![GitHub stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
   7 [![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)
   8 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
   9 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
  10 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  11 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
  12 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  13 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  14 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  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
  27 ## Features
  28
  29 - Open source, [AGPL License](/LICENSE).
  30 - Self hostable, easy to deploy.
  31   - Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes).
  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   - Can transfer site and communities to others.
  40 - Clean, mobile-friendly interface.
  41 - i18n / internationalization support.
  42 - NSFW post / community support.
  43 - Cross-posting support.
  44 - A *similar post search* when creating new posts. Great for question / answer communities.
  45 - High performance.
  46   - Server is written in rust.
  47   - Front end is `~80kB` gzipped.
  48
  49 ## About
  50
  51 [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).
  52
  53 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.
  54
  55 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.
  56
  57 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.
  58
  59 ## Why's it called Lemmy?
  60
  61 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  62 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  63 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  64 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  65
  66 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/).
  67
  68 ## Install
  69
  70 ### Docker
  71
  72 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
  73
  74 ```bash
  75 mkdir lemmy/
  76 cd lemmy/
  77 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  78 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
  79 # Edit the .env if you want custom passwords
  80 docker-compose up -d
  81 ```
  82
  83 and goto http://localhost:8536
  84
  85 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
  86
  87 ```bash
  88 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
  89 # Replace the {{ vars }}
  90 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
  91 ```
  92 #### Updating
  93
  94 To update to the newest version, run:
  95
  96 ```bash
  97 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  98 docker-compose up -d
  99 ```
 100
 101 ### Ansible
 102
 103 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
 104 eg using `sudo apt install ansible`, or the equivalent for you platform.
 105
 106 Then run the following commands on your local computer:
 107
 108 ```bash
 109 git clone https://github.com/dessalines/lemmy.git
 110 cd lemmy/ansible/
 111 cp inventory.example inventory
 112 nano inventory # enter your server, domain, contact email
 113 ansible-playbook lemmy.yml --become
 114 ```
 115
 116 ### Kubernetes
 117
 118 You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/).
 119 Setting this up will vary depending on your provider.
 120 To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
 121
 122 Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`.
 123 You may also want to change the service types to use `LoadBalancer`s depending on where you're running your cluster (add `type: LoadBalancer` to `ports)`, or `NodePort`s.
 124 By default they will use `ClusterIP`s, which will allow access only within the cluster. See the [docs](https://kubernetes.io/docs/concepts/services-networking/service/) for more on networking in Kubernetes.
 125
 126 **Important** Running a database in Kubernetes will work, but is generally not recommended.
 127 If you're deploying on any of the common cloud providers, you should consider using their managed database service instead (RDS, Cloud SQL, Azure Databse, etc.).
 128
 129 Now you can deploy:
 130
 131 ```bash
 132 # Add `-n foo` if you want to deploy into a specific namespace `foo`;
 133 # otherwise your resources will be created in the `default` namespace.
 134 kubectl apply -f docker/k8s/db.yml
 135 kubectl apply -f docker/k8s/pictshare.yml
 136 kubectl apply -f docker/k8s/lemmy.yml
 137 ```
 138
 139 If you used a `LoadBalancer`, you should see it in your cloud provider's console.
 140
 141 ## Develop
 142
 143 ### Docker Development
 144
 145 ```bash
 146 git clone https://github.com/dessalines/lemmy
 147 cd lemmy/docker/dev
 148 ./docker_update.sh # This builds and runs it, updating for your changes
 149 ```
 150
 151 and goto http://localhost:8536
 152
 153 ### Local Development
 154
 155 #### Requirements
 156
 157 - [Rust](https://www.rust-lang.org/)
 158 - [Yarn](https://yarnpkg.com/en/)
 159 - [Postgres](https://www.postgresql.org/)
 160
 161 #### Set up Postgres DB
 162
 163 ```bash
 164  psql -c "create user lemmy with password 'password' superuser;" -U postgres
 165  psql -c 'create database lemmy with owner lemmy;' -U postgres
 166  export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
 167 ```
 168
 169 #### Running
 170
 171 ```bash
 172 git clone https://github.com/dessalines/lemmy
 173 cd lemmy
 174 ./install.sh
 175 # For live coding, where both the front and back end, automagically reload on any save, do:
 176 # cd ui && yarn start
 177 # cd server && cargo watch -x run
 178 ```
 179
 180 ## Documentation
 181
 182 - [Websocket API for App developers](docs/api.md)
 183 - [ActivityPub API.md](docs/apub_api_outline.md)
 184 - [Goals](docs/goals.md)
 185 - [Ranking Algorithm](docs/ranking.md)
 186
 187 ## Support
 188
 189 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 190 - [Support on Patreon](https://www.patreon.com/dessalines).
 191 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 192 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 193 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 194 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 195
 196 ## Translations
 197
 198 If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
 199
 200 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`).
 201
 202 lang | done | missing
 203 --- | --- | ---
 204 de | 82% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,subscribed,expires,recent_comments,nsfw,show_nsfw,theme,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 205 eo | 91% | number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,theme,are_you_sure,yes,no
 206 es | 100% |
 207 fr | 100% |
 208 nl | 93% | preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,theme
 209 ru | 86% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 210 sv | 100% |
 211 zh | 84% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 212
 213 ## Credits
 214
 215 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license