README.md

   1 <h1><img src="https://image.flaticon.com/icons/svg/194/194242.svg" width="50px" height="50px" /> Lemmy</h1>
   2
   3 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
   4 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
   5 ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/dessalines/lemmy.svg)
   6 [![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
   7 [![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
   8 ![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)
   9 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
  10 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
  11 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
  12 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
  13 [![Mastodon](https://img.shields.io/badge/Mastodon-follow-lightgrey.svg)](https://mastodon.social/@LemmyDev)
  14 [![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)
  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 ## Features
  27 - Open source, [AGPL License](/LICENSE).
  28 - Self hostable, easy to deploy.
  29   - Comes with [Docker](#docker), [Kubernetes](#kubernetes).
  30 - Live-updating Comment threads.
  31 - Full vote scores `(+/-)` like old reddit.
  32 - Moderation abilities.
  33   - Public Moderation Logs.
  34   - Both site admins, and community moderators, who can appoint other moderators.
  35   - Can lock, remove, and restore posts and comments.
  36   - Can ban and unban users from communities and the site.
  37 - Clean, mobile-friendly interface.
  38 - High performance.
  39   - Server is written in rust.
  40   - Front end is `~80kB` gzipped.
  41 ## About
  42 [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).
  43
  44 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.
  45
  46 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.
  47
  48 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.
  49
  50 ## Why's it called Lemmy?
  51 - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  52 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  53 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  54 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  55
  56 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/).
  57 ## Install
  58 ### Docker
  59 Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
  60
  61 ```
  62 git clone https://github.com/dessalines/lemmy
  63 cd lemmy/docker
  64 docker-compose up -d
  65 ```
  66
  67 and goto http://localhost:8536
  68 ## Develop
  69 ### Docker Development
  70
  71 ```
  72 git clone https://github.com/dessalines/lemmy
  73 cd lemmy
  74 ./docker_update.sh # This pulls the newest version, builds and runs it
  75 ```
  76
  77 and goto http://localhost:8536
  78 ### Kubernetes
  79 #### Requirements
  80 - Local or remote Kubernetes cluster, i.e. [`minikube`](https://kubernetes.io/docs/tasks/tools/install-minikube/)
  81 - [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
  82 - [`skaffold`](https://skaffold.dev/)
  83 #### Production
  84 ```bash
  85 # Deploy the Traefik Ingress
  86 kubectl apply -f https://raw.githubusercontent.com/containous/traefik/v1.7/examples/k8s/traefik-rbac.yaml
  87 kubectl apply -f https://raw.githubusercontent.com/containous/traefik/v1.7/examples/k8s/traefik-ds.yaml
  88 # Replace ${IP} with your Ingress' IP
  89 echo "${IP} dev.lemmy.local" >> /etc/hosts
  90 ```
  91
  92 ```bash
  93 skaffold run -p lemmy--prod
  94 ```
  95
  96 Now go to http://dev.lemmy.local.
  97 #### Development
  98 ```bash
  99 skaffold dev -p lemmy--dev
 100 ```
 101
 102 Now go to http://localhost:4444. It automatically proxies to localhost, both if the cluster is local or remote; it also hot-reloads the UI and automatically recompiles and restarts the server.
 103 ### Local Development
 104 #### Requirements
 105 - [Rust](https://www.rust-lang.org/)
 106 - [Yarn](https://yarnpkg.com/en/)
 107 - [Postgres](https://www.sqlite.org/index.html)
 108 #### Set up Postgres DB
 109 ```
 110  psql -c "create user rrr with password 'rrr' superuser;" -U postgres
 111  psql -c 'create database rrr with owner rrr;' -U postgres
 112 ```
 113 #### Running
 114 ```
 115 git clone https://github.com/dessalines/lemmy
 116 cd lemmy
 117 ./install.sh
 118 # For live coding, where both the front and back end, automagically reload on any save, do:
 119 # cd ui && yarn start
 120 # cd server && cargo watch -x run
 121 ```
 122
 123 and goto http://localhost:8536
 124 ## Documentation
 125 - [Websocket API for App developers](docs/api.md)
 126 - [ActivityPub API.md](docs/apub_api_outline.md)
 127 - [Goals](docs/goals.md)
 128 - [Ranking Algorithm](docs/ranking.md)
 129 ## Support
 130 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 131 - [Support on Patreon](https://www.patreon.com/dessalines).
 132 - [Sponsor List](https://dev.lemmy.ml/#/sponsors).
 133 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 134 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 135 ## Credits
 136 Icons made by [Freepik](https://www.freepik.com/) licensed by [CC 3.0](http://creativecommons.org/licenses/by/3.0/)