lemmy/README.md

170 lines
7.2 KiB
Markdown
Raw Normal View History

2019-08-17 05:21:08 +00:00
<h1><img src="ui/assets/favicon.svg" width="50px" height="50px" style="vertical-align:bottom" /><span>Lemmy</span></h1>
2019-02-14 17:36:53 +00:00
[![Github](https://img.shields.io/badge/-Github-blue)](https://github.com/dessalines/lemmy)
[![Gitlab](https://img.shields.io/badge/-Gitlab-yellowgreen)](https://gitlab.com/dessalines/lemmy)
2019-05-14 19:43:35 +00:00
![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
2019-04-06 15:32:34 +00:00
[![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
2019-04-06 20:03:44 +00:00
[![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
[![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
2019-08-17 02:57:23 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
2019-04-06 20:03:44 +00:00
[![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
2019-05-14 19:43:35 +00:00
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
[![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
2019-08-17 02:57:23 +00:00
[![Mastodon](https://img.shields.io/badge/Mastodon-@LemmyDev-lightgrey.svg)](https://mastodon.social/@LemmyDev)
2019-04-06 20:03:44 +00:00
[![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)
2019-04-22 20:35:51 +00:00
[![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
2019-04-06 15:32:34 +00:00
2019-04-06 17:19:05 +00:00
A link aggregator / reddit clone for the fediverse.
2019-02-14 17:36:53 +00:00
2019-04-27 13:55:12 +00:00
[Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
2019-02-15 01:42:04 +00:00
2019-04-22 20:35:51 +00:00
This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
2019-05-04 15:58:53 +00:00
Front Page|Post
---|---
![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png)
2019-04-06 17:19:05 +00:00
## Features
2019-04-22 20:55:29 +00:00
- Open source, [AGPL License](/LICENSE).
2019-04-17 00:32:13 +00:00
- Self hostable, easy to deploy.
- Comes with [Docker](#docker), [Ansible](#ansible).
2019-04-17 00:32:13 +00:00
- Live-updating Comment threads.
- Full vote scores `(+/-)` like old reddit.
2019-04-22 20:55:29 +00:00
- Moderation abilities.
- Public Moderation Logs.
- Both site admins, and community moderators, who can appoint other moderators.
- Can lock, remove, and restore posts and comments.
- Can ban and unban users from communities and the site.
- Clean, mobile-friendly interface.
- i18n / internationalization support.
- NSFW post / community support.
2019-08-23 03:45:20 +00:00
- Cross-posting support.
2019-04-17 00:32:13 +00:00
- High performance.
- Server is written in rust.
- Front end is `~80kB` gzipped.
2019-04-21 17:15:40 +00:00
## About
2019-04-22 20:55:29 +00:00
[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).
2019-04-22 20:35:51 +00:00
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.
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.
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.
2019-05-04 15:58:53 +00:00
2019-04-16 23:04:23 +00:00
## Why's it called Lemmy?
2019-04-16 23:04:23 +00:00
- Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U).
- The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
- The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
2019-04-16 23:04:23 +00:00
- The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
2019-04-22 20:35:51 +00:00
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/).
2019-05-04 15:58:53 +00:00
## Install
### Docker
Make sure you have both docker and docker-compose(>=`1.24.0`) installed.
2019-08-15 16:36:34 +00:00
2019-08-22 04:09:46 +00:00
```bash
2019-08-15 21:21:27 +00:00
mkdir lemmy/
cd lemmy/
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/.env
# Edit the .env if you want custom passwords
docker-compose up -d
```
and goto http://localhost:8536
[A sample nginx config](/docker/prod/nginx.conf), could be setup with:
2019-08-22 04:09:46 +00:00
```bash
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/nginx.conf
# Replace the {{ vars }}
sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
```
### Ansible
First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html),
eg using `sudo apt install ansible`, or the equivalent for you platform.
Then run the following commands on your local computer:
```bash
git clone https://github.com/dessalines/lemmy.git
cd lemmy/ansible/
cp inventory.example inventory
nano inventory # enter your server, domain, contact email
ansible-playbook lemmy.yml
```
## Develop
### Docker Development
2019-08-22 04:09:46 +00:00
```bash
2019-05-04 15:58:53 +00:00
git clone https://github.com/dessalines/lemmy
2019-08-22 04:09:46 +00:00
cd lemmy/docker/dev
./docker_update.sh # This builds and runs it, updating for your changes
2019-05-04 15:58:53 +00:00
```
and goto http://localhost:8536
2019-05-04 15:58:53 +00:00
### Local Development
#### Requirements
2019-04-06 17:19:05 +00:00
- [Rust](https://www.rust-lang.org/)
- [Yarn](https://yarnpkg.com/en/)
- [Postgres](https://www.postgresql.org/)
#### Set up Postgres DB
2019-08-22 04:09:46 +00:00
```bash
psql -c "create user lemmy with password 'password' superuser;" -U postgres
psql -c 'create database lemmy with owner lemmy;' -U postgres
export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
2019-04-06 17:19:05 +00:00
```
#### Running
2019-08-22 04:09:46 +00:00
```bash
2019-04-06 17:19:05 +00:00
git clone https://github.com/dessalines/lemmy
cd lemmy
./install.sh
2019-04-18 16:24:24 +00:00
# For live coding, where both the front and back end, automagically reload on any save, do:
# cd ui && yarn start
# cd server && cargo watch -x run
2019-04-06 17:19:05 +00:00
```
2019-04-06 17:19:05 +00:00
## Documentation
- [Websocket API for App developers](docs/api.md)
- [ActivityPub API.md](docs/apub_api_outline.md)
2019-04-06 22:49:51 +00:00
- [Goals](docs/goals.md)
- [Ranking Algorithm](docs/ranking.md)
2019-04-17 00:32:13 +00:00
## Support
Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
- [Support on Patreon](https://www.patreon.com/dessalines).
- [Sponsor List](https://dev.lemmy.ml/sponsors).
2019-05-17 15:32:07 +00:00
- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
2019-04-17 00:32:13 +00:00
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
## Translations
If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts).
2019-08-23 03:45:20 +00:00
- Languages supported: English (`en`), Chinese (`zh`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`).
2019-04-06 22:49:51 +00:00
## Credits
Icon made by Andy Cuccaro (@andycuccaro).