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 - Clean, mobile-friendly interface.
  33   - Live-updating Comment threads.
  34   - Full vote scores `(+/-)` like old reddit.
  35   - Themes, including light, dark, and solarized.
  36   - Emojis with autocomplete support. Start typing `:`
  37   - User tagging using `@`, Community tagging using `#`.
  38   - Notifications, on comment replies and when you're tagged.
  39   - i18n / internationalization support.
  40 - Cross-posting support.
  41   - A *similar post search* when creating new posts. Great for question / answer communities.
  42 - Moderation abilities.
  43   - Public Moderation Logs.
  44   - Both site admins, and community moderators, who can appoint other moderators.
  45   - Can lock, remove, and restore posts and comments.
  46   - Can ban and unban users from communities and the site.
  47   - Can transfer site and communities to others.
  48 - Can fully erase your data, replacing all posts and comments.
  49 - NSFW post / community support.
  50 - High performance.
  51   - Server is written in rust.
  52   - Front end is `~80kB` gzipped.
  53
  54 ## About
  55
  56 [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).
  57
  58 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.
  59
  60 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.
  61
  62 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.
  63
  64 ## Why's it called Lemmy?
  65
  66 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  67 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  68 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  69 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  70
  71 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/).
  72
  73 ## Install
  74
  75 ### Docker
  76
  77 Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
  78
  79 ```bash
  80 mkdir lemmy/
  81 cd lemmy/
  82 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
  83 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
  84 # Edit the .env if you want custom passwords
  85 docker-compose up -d
  86 ```
  87
  88 and go to http://localhost:8536.
  89
  90 [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
  91
  92 ```bash
  93 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
  94 # Replace the {{ vars }}
  95 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
  96 ```
  97 #### Updating
  98
  99 To update to the newest version, run:
 100
 101 ```bash
 102 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 103 docker-compose up -d
 104 ```
 105
 106 ### Ansible
 107
 108 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform.
 109
 110 Then run the following commands on your local computer:
 111
 112 ```bash
 113 git clone https://github.com/dessalines/lemmy.git
 114 cd lemmy/ansible/
 115 cp inventory.example inventory
 116 nano inventory # enter your server, domain, contact email
 117 ansible-playbook lemmy.yml --become
 118 ```
 119
 120 ### Kubernetes
 121
 122 You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/).
 123 Setting this up will vary depending on your provider.
 124 To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
 125
 126 Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`.
 127 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.
 128 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.
 129
 130 **Important** Running a database in Kubernetes will work, but is generally not recommended.
 131 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.).
 132
 133 Now you can deploy:
 134
 135 ```bash
 136 # Add `-n foo` if you want to deploy into a specific namespace `foo`;
 137 # otherwise your resources will be created in the `default` namespace.
 138 kubectl apply -f docker/k8s/db.yml
 139 kubectl apply -f docker/k8s/pictshare.yml
 140 kubectl apply -f docker/k8s/lemmy.yml
 141 ```
 142
 143 If you used a `LoadBalancer`, you should see it in your cloud provider's console.
 144
 145 ## Develop
 146
 147 ### Docker Development
 148
 149 Run:
 150
 151 ```bash
 152 git clone https://github.com/dessalines/lemmy
 153 cd lemmy/docker/dev
 154 ./docker_update.sh # This builds and runs it, updating for your changes
 155 ```
 156
 157 and go to http://localhost:8536.
 158
 159 ### Local Development
 160
 161 #### Requirements
 162
 163 - [Rust](https://www.rust-lang.org/)
 164 - [Yarn](https://yarnpkg.com/en/)
 165 - [Postgres](https://www.postgresql.org/)
 166
 167 #### Set up Postgres DB
 168
 169 ```bash
 170  psql -c "create user lemmy with password 'password' superuser;" -U postgres
 171  psql -c 'create database lemmy with owner lemmy;' -U postgres
 172  export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
 173 ```
 174
 175 #### Running
 176
 177 ```bash
 178 git clone https://github.com/dessalines/lemmy
 179 cd lemmy
 180 ./install.sh
 181 # For live coding, where both the front and back end, automagically reload on any save, do:
 182 # cd ui && yarn start
 183 # cd server && cargo watch -x run
 184 ```
 185
 186 ## Documentation
 187
 188 - [Websocket API for App developers](docs/api.md)
 189 - [ActivityPub API.md](docs/apub_api_outline.md)
 190 - [Goals](docs/goals.md)
 191 - [Ranking Algorithm](docs/ranking.md)
 192
 193 ## Support
 194
 195 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 196
 197 - [Support on Patreon](https://www.patreon.com/dessalines).
 198 - [Sponsor List](https://dev.lemmy.ml/sponsors).
 199 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 200 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 201 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 202
 203 ## Translations
 204
 205 If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts).
 206
 207 - Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`).
 208
 209 lang | done | missing
 210 --- | --- | ---
 211 de | 81% | 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,replies,mentions,expires,recent_comments,nsfw,show_nsfw,theme,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 212 eo | 90% | number_of_communities,preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,theme,are_you_sure,yes,no
 213 es | 99% | replies,mentions
 214 fr | 99% | replies,mentions
 215 it | 100% |
 216 nl | 92% | preview,upload_image,formatting_help,view_source,sticky,unsticky,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,theme
 217 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,replies,mentions,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 218 sv | 99% | replies,mentions
 219 zh | 83% | 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,replies,mentions,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no
 220
 221 If you'd like to update this report, run:
 222
 223 ```bash
 224 cd ui
 225 ts-node translation_report.ts > tmp # And replace the text above.
 226 ```
 227
 228 ## Credits
 229
 230 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.