A mobile-first Lemmy web client
Report Bug ยท Request Feature ยท Releases
However, if you prefer using the Progressive Web App, there are a number of folks that host it:
| Country | URL | Description | Contact/Privacy |
| ---------------- | -------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------- |
| ๐บ๐ธ Virginia, USA | [vger.app](https://vger.app) | โ
Official Voyager PWA instance | [โก๏ธ](https://vger.social/u/aeharding) |
| ๐ซ๐ฎ Finland | [m.lemmy.world](https://m.lemmy.world) | Voyager hosted by the mastodon.world team. | [โก๏ธ](https://mastodon.world/about) |
| ๐ธ๐ฌ Singapore | [v.opnxng.com](https://v.opnxng.com) | Voyager hosted by Opnxng in Singapore. | [โก๏ธ](https://about.opnxng.com) |
| ๐ฒ๐ฝ Mexico | [voyager.nohost.network](https://voyager.nohost.network) | Voyager hosted by Nohost in Mexico. | [โก๏ธ](https://nohost.network) |
| ๐บ๐ธ USA | [vger.thesanewriter.com](https://vger.thesanewriter.com) | Voyager hosted by the lemmy.thesanewriter.com team. | [โก๏ธ](https://lemmy.thesanewriter.com/legal) |
| ๐บ๐ธ Oregon, USA | [m.lemmy.today](https://m.lemmy.today) | A fast, general purpose instance located in Oregon, USA | [โก๏ธ](https://lemmy.today) |
| ๐ซ๐ท France | [v.lemmy.dbzer0.com](https://v.lemmy.dbzer0.com) | Be Weird, Download a Car, Generate Art, Screw Copyrights | [โก๏ธ](https://lemmy.dbzer0.com) |
| ? | [v.programming.dev](https://v.programming.dev) | A collection of programming communities | [โก๏ธ](https://legal.programming.dev) |
| ๐บ๐ธ Oregon, USA | [v.lemmy.eco.br](https://v.lemmy.eco.br) | A fast, general purpose instance located in Oregon, USA | [โก๏ธ](https://lemmy.eco.br) |
| ๐ฉ๐ช Germany | [v.lemy.lol](https://v.lemy.lol) | Long-term, general purpose Lemmy instance. | [โก๏ธ](https://lemy.lol) |
| ๐ต๐น Portugal | [voyager.slrpnk.net](https://voyager.slrpnk.net) | Sustainable future interconnected with nature and community. | [โก๏ธ](https://slrpnk.net) |
| ? | [app.thelemmy.club](https://app.thelemmy.club) | A general Lemmy instance for all! | [โก๏ธ](https://thelemmy.club) |
| ? | [m.lemdro.id](https://m.lemdro.id) | Fully open source instance with incredible transparency. | [โก๏ธ](https://lemdro.id) |
> **Note**: Community deployments are **NOT** maintained by the Voyager team. They may not be synced with Voyager's source code. Please do your own research about the host servers before using them.
### Self-Host
There are two ways you can run Voyager as a PWA in a production environment. The recommended method is using **docker**. We also support a **traditional** deployment method without docker. Read below to see how to get each method set up.
#### Environment variables
- `CUSTOM_LEMMY_SERVERS` (optional) e.g. `lemmy.world,lemmy.ml,sh.itjust.works` - a comma separated list of suggested servers. The first will be used as default view for logged out users. You can specify only one if you want.
#### Docker Deployment
In order to host Voyager yourself you can use the provided Dockerfile to build a container with Voyager. The Docker container itself does not provide any SSL/TLS handling. You'll have to add this bit yourself.
One could put Voyager behind popular reverse proxies with SSL Handling like Traefik, NGINX etc.
> **Tip:** Use [Watchtower](https://github.com/containrrr/watchtower) to keep your deployment automatically up to date!
##### From source
1. checkout source `git clone https://github.com/aeharding/voyager.git`
1. go into new source dir: `cd voyager`
1. build Docker image: `docker build . -t voyager`
1. start container: `docker run --init --rm -it -p 5314:5314 voyager`
##### Prebuilt
1. pull image `docker pull ghcr.io/aeharding/voyager:latest`
1. start container: `docker run --init --rm -it -p 5314:5314 voyager`
Note: The provided Dockerfile creates a container which will eventually run Voyager as non-root user.
#### Traditional Deployment
While Docker makes things easier, Voyager can be hosted by any HTTP server (nginx, apache etc).
```sh
# Build from source (Or, download web artifact from Github Releases)
pnpm install
pnpm build
# Then, serve ./dist with your favorite HTTP server - nginx, apache etc
# (make sure 404 goes to index.html)
# Below is a simple example for dev/testing (not recommended for production):
npm install --global http-server
cp dist/index.html dist/404.html # magic file for http-server
http-server dist
```
Optionally, you can serve a custom list of instance(s) in the `/_config` endpoint, with JSON payload of following format:
```json
{ "customServers": ["lemmy.world", "lemm.ee"] }
```
For production, serve `index.html` with `Cache-Control: no-cache` and `/assets` with a long cache period (files in assets are immutable)
## ๐ Sponsors
If you're enjoying Voyager, you can sponsor it:
- [Alexander Harding](https://github.com/sponsors/aeharding)
We would also appreciate sponsoring other contributors to Voyager. If someone helps you solve an issue or implement a feature you wanted, supporting them would help make this project and OS more sustainable.
## ๐งโ๐ป Contributing
Please check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on contributing to Voyager. Thank you! ๐
## ๐ Add a lemmy instance to the curated list
Voyager curates Lemmy servers for sign up ([see the data](./src/features/auth/login/data/servers.ts)). If you would like to add an instance, please read the [curated servers policy](./src/features/auth/login/data/README.md).
## ๐ฒ PWA
Voyager works best added to the homescreen. There are certain features that only work there, like badging and smooth page transitions.
## ๐ฆ Stack
- [React](https://react.dev/) - The library for web and native user interfaces
- [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling
- [Ionic](https://ionicframework.com/) - The mobile SDK for the Web
- [Virtua](https://github.com/inokawa/virtua) - A zero-config, fast and small virtual list
- [vite-plugin-pwa](https://github.com/vite-pwa/vite-plugin-pwa) - Prompt for update, Web Push Notifications and Web Share Target API
## ๐จโ๐ป Contributors
Shoutout to [@fer0n](https://github.com/fer0n) for the great logo and splashscreen! And thank you ๐ all of our contributors to the codebase: