mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-11-30 16:21:24 +00:00
136 lines
6.6 KiB
Markdown
136 lines
6.6 KiB
Markdown
<h1><img src="https://image.flaticon.com/icons/svg/194/194242.svg" width="50px" height="50px" /> Lemmy</h1>
|
|
|
|
|
|
[](https://travis-ci.org/dessalines/lemmy)
|
|
|
|
[](https://github.com/dessalines/lemmy)
|
|
[](https://github.com/dessalines/lemmy/fork)
|
|
|
|
[](https://github.com/dessalines/lemmy/issues)
|
|
|
|
|
|
[](LICENSE)
|
|
[](https://mastodon.social/@LemmyDev)
|
|
[](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
|
|
[](https://www.patreon.com/dessalines)
|
|
|
|
A link aggregator / reddit clone for the fediverse.
|
|
|
|
[Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
|
|
|
|
This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
|
|
|
|
Front Page|Post
|
|
---|---
|
|
|
|
|
## Features
|
|
- Open source, [AGPL License](/LICENSE).
|
|
- Self hostable, easy to deploy.
|
|
- Comes with [Docker](#docker), [Kubernetes](#kubernetes).
|
|
- Live-updating Comment threads.
|
|
- Full vote scores `(+/-)` like old reddit.
|
|
- 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.
|
|
- High performance.
|
|
- Server is written in rust.
|
|
- Front end is `~80kB` gzipped.
|
|
## About
|
|
[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).
|
|
|
|
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.
|
|
|
|
## Why's it called Lemmy?
|
|
- 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).
|
|
- The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
|
|
|
|
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/).
|
|
## Install
|
|
### Docker
|
|
Make sure you have both docker and docker-compose installed.
|
|
|
|
```
|
|
git clone https://github.com/dessalines/lemmy
|
|
cd lemmy/docker
|
|
docker-compose up -d
|
|
```
|
|
|
|
and goto http://localhost:8536
|
|
## Develop
|
|
### Docker Development
|
|
|
|
```
|
|
git clone https://github.com/dessalines/lemmy
|
|
cd lemmy
|
|
./docker_update.sh # This pulls the newest version, builds and runs it
|
|
```
|
|
|
|
and goto http://localhost:8536
|
|
### Kubernetes
|
|
#### Requirements
|
|
- Local or remote Kubernetes cluster, i.e. [`minikube`](https://kubernetes.io/docs/tasks/tools/install-minikube/)
|
|
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
- [`skaffold`](https://skaffold.dev/)
|
|
#### Production
|
|
```bash
|
|
# Deploy the Traefik Ingress
|
|
kubectl apply -f https://raw.githubusercontent.com/containous/traefik/v1.7/examples/k8s/traefik-rbac.yaml
|
|
kubectl apply -f https://raw.githubusercontent.com/containous/traefik/v1.7/examples/k8s/traefik-ds.yaml
|
|
# Replace ${IP} with your Ingress' IP
|
|
echo "${IP} dev.lemmy.local" >> /etc/hosts
|
|
```
|
|
|
|
```bash
|
|
skaffold run -p lemmy--prod
|
|
```
|
|
|
|
Now go to http://dev.lemmy.local.
|
|
#### Development
|
|
```bash
|
|
skaffold dev -p lemmy--dev
|
|
```
|
|
|
|
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.
|
|
### Local Development
|
|
#### Requirements
|
|
- [Rust](https://www.rust-lang.org/)
|
|
- [Yarn](https://yarnpkg.com/en/)
|
|
- [Postgres](https://www.sqlite.org/index.html)
|
|
#### Set up Postgres DB
|
|
```
|
|
psql -c "create user rrr with password 'rrr' superuser;" -U postgres
|
|
psql -c 'create database rrr with owner rrr;' -U postgres
|
|
```
|
|
#### Running
|
|
```
|
|
git clone https://github.com/dessalines/lemmy
|
|
cd lemmy
|
|
./install.sh
|
|
# 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
|
|
```
|
|
|
|
and goto http://localhost:8536
|
|
## Documentation
|
|
- [Websocket API for App developers](docs/api.md)
|
|
- [ActivityPub API.md](docs/apub_api_outline.md)
|
|
- [Goals](docs/goals.md)
|
|
- [Ranking Algorithm](docs/ranking.md)
|
|
## 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).
|
|
- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
|
|
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
|
|
## Credits
|
|
Icons made by [Freepik](https://www.freepik.com/) licensed by [CC 3.0](http://creativecommons.org/licenses/by/3.0/)
|