Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #257

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Documentation updates #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1f5397
Update Xylight's profile picture in credits...
CorvetteCole Feb 23, 2024
bf0d399
Add cheeky lemdro.id to public instance list
CorvetteCole Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,18 @@ There you go, you now have an instance of Photon running.

### Configuring default settings

The most common settings you'll use are `PUBLIC_INSTANCE_URL`. Some selfhosters with `PUBLIC_SSR_ENABLED` set to true might want the instance url to be different for the server. You can use the `PUBLIC_INTERNAL_INSTANCE` variable for that.
The most common settings you'll use are `PUBLIC_INSTANCE_URL`. Some selfhosters with `PUBLIC_SSR_ENABLED` set to true
might want the instance url to be different for the server. You can use the `PUBLIC_INTERNAL_INSTANCE` variable for
that.

`PUBLIC_MIGRATE_COOKIE` is useful if you want to switch Photon to your default frontend. It'll convert the logged in cookie from lemmy-ui to a Photon account. It will only work if you have `PUBLIC_INSTANCE_URL` set, and it will login with that instance.
`PUBLIC_MIGRATE_COOKIE` is useful if you want to switch Photon to your default frontend. It'll convert the logged in
cookie from lemmy-ui to a Photon account. It will only work if you have `PUBLIC_INSTANCE_URL` set, and it will login
with that instance.

The following environment variables can be set to override the default settings:


| Variable | Values | Default Value |
| ------------------------------- | ------------------- | -------------------------------------- |
|---------------------------------|---------------------|----------------------------------------|
| PUBLIC_INSTANCE_URL | URL | `lemmy.ml` |
| PUBLIC_INTERNAL_INSTANCE | URL? | null |
| PUBLIC_LOCK_TO_INSTANCE | `bool` | `true` if `PUBLIC_INSTANCE_URL` is set |
Expand Down Expand Up @@ -133,16 +136,16 @@ Want your instance added here? Make a GitHub issue or make a PR! (this is for ge

[phtn.app](https://phtn.app) is the official instance and will get updates instantly.


| Instance | Location | Contact |
| --------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------- |
| [phtn.app (Official)](https://phtn.app) | 🇺🇸 US West | [[email protected]](mailto:[email protected]) |
| Instance | Location | Contact |
|-----------------------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------|
| [phtn.app (Official)](https://phtn.app) | 🇺🇸 US West | [[email protected]](mailto:[email protected]) |
| [lemdro.id](https://lemdro.id) | Global | [[email protected]](mailto:[email protected]) |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lemdro.id doesn't allow setting custom instance and README.md states that "this is for general purpose Photon instances". It should be excluded.

| [ph.opnxng.com](https://ph.opnxng.com) | 🇸🇬 Singapore | [about.opnxng.com](https://about.opnxng.com) |
| [photon.thesanewriter.com](https://photon.thesanewriter.com) | 🇺🇸 US East | [[email protected]](mailto:[email protected]) |
| [p.lemmy.ohaa.xyz](https://p.lemmy.ohaa.xyz) | 🇦🇹 Austria | (???) |
| [~~photon.zhenyapav.com~~ (Has not updated since v1.9.2)](https://photon.zhenyapav.com) | 🇮🇸 Iceland | [[email protected]](mailto:[email protected]) |
| [~~ph.buckodr.ink~~ (Has not updated since v1.21.1)](https://ph.buckodr.ink) | 🇺🇸 US East | [[email protected]](mailto:[email protected]) |
| [phtn.ngn.tf](https://phtn.ngn.tf) | 🇹🇷 Turkey | [[email protected]](mailto:[email protected])
| [phtn.ngn.tf](https://phtn.ngn.tf) | 🇹🇷 Turkey | [[email protected]](mailto:[email protected]) |

## Donate

Expand Down
2 changes: 1 addition & 1 deletion src/routes/about/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<h1 class="text-2xl font-bold leading-8">Credits</h1>
<div class="grid grid-cols-1 sm:grid-cols-3 gap-4">
<Profile
avatar="https://lemmy.xylight.dev/pictrs/image/3281f13c-68bb-47c9-8c98-b67f67714d5a.png?format=webp&thumbnail=128"
avatar="https://avatars.githubusercontent.com/u/80978739?v=4"
description="Main developer"
name="Xylight"
class="sm:col-span-3 place-self-center"
Expand Down
Loading