Files
photon-tbw/README.md
T
2023-12-29 09:13:39 +00:00

152 lines
7.4 KiB
Markdown

Photon
Jump to:
- [Self-hosting](#self-hosting)
- [Public Instances](#public-instances)
An sleek web client for Lemmy using mono-ui, a custom design system.
## Screenshots
![Screenshot from 2023-10-07 12-44-01](https://github.com/Xyphyn/photon/assets/80978739/4807c0aa-1ffe-4f6d-b33a-432d68def70d)
![Screenshot from 2023-10-07 12-44-07](https://github.com/Xyphyn/photon/assets/80978739/1a6f1515-f95a-447d-8d3c-39e9d8e48dd1)
## Self-hosting
Put Photon on your own domain for easier onboarding.
### Running from image
```sh
# Use the env var PUBLIC_INSTANCE_URL to set the default instance URL.
docker run -p 8080:3000 -e PUBLIC_INSTANCE_URL=example.com ghcr.io/xyphyn/photon:latest
```
### Running from repo
**More unstable but latest features**
Clone the repo:
```sh
git clone https://github.com/Xyphyn/photon && cd photon
```
and run the docker container:
```sh
docker build -t photon .
# Use the env var PUBLIC_INSTANCE_URL to set the default instance URL.
docker run -p 8080:3000 -it photon:latest
```
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.
`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 |
| PUBLIC_SSR_ENABLED | `bool` | `false` |
| PUBLIC_MIGRATE_COOKIE | `bool` | `false` |
| PUBLIC_THEME | system\|dark\|light | system |
| PUBLIC_EXPANDABLE_IMAGES | `bool` | true |
| PUBLIC_MARK_READ_POSTS | `bool` | true |
| PUBLIC_REVERT_VOTE_COLORS | `bool` | false |
| PUBLIC_SHOW_INSTANCES_USER | `bool` | false |
| PUBLIC_SHOW_INSTANCES_COMMUNITY | `bool` | true |
| PUBLIC_SHOW_INSTANCES_COMMENTS | `bool` | false |
| PUBLIC_SHOW_COMPACT_POSTS | `bool` | false |
| PUBLIC_DEFAULT_FEED_SORT | `SortType` | Active |
| PUBLIC_DEFAULT_FEED | `ListingType` | Local |
| PUBLIC_DEFAULT_COMMENT_SORT | `CommentSortType` | Hot |
| PUBLIC_HIDE_DELETED | `bool` | true |
| PUBLIC_HIDE_REMOVED | `bool` | false |
| PUBLIC_FULL_WIDTH_LAYOUT | `bool` | false |
| PUBLIC_EXPAND_SIDEBAR | `bool` | true |
| PUBLIC_DISPLAY_NAMES | `bool` | true |
| PUBLIC_NSFW_BLUR | `bool` | true |
| PUBLIC_NEW_VOTE_BUTTONS | `bool` | false |
| PUBLIC_RANDOM_PLACEHOLDERS | `bool` | true |
| PUBLIC_REMOVE_CREDIT | `bool` | false |
The values for `SortType`, `ListingType`, and `CommentSortType` are defined by the lemmy-js-client library.
#### Listing Type
https://github.com/LemmyNet/lemmy-js-client/blob/main/src/types/ListingType.ts
- All
- Local
- Subscribed
- Moderator View (not implemented in Photon)
#### Sort Type
(case sensitive)
https://github.com/LemmyNet/lemmy-js-client/blob/main/src/types/SortType.ts
- Active
- Hot
- New
- Old
- TopDay
- TopWeek
- TopMonth
- TopAll
- MostComments
- NewComments
- TopHour
- TopSixHour
- TopTwelveHour (Not implemented in Photon)
- TopThreeMonths (Not implemented in Photon)
- TopSixMonths (Not implemented in Photon)
- TopNineMonths (Not implemented in Photon)
- TopYear (Not implemented in Photon)
#### Comment Sort Type
https://github.com/LemmyNet/lemmy-js-client/blob/main/src/types/CommentSortType.ts
values:
- Hot
- Top
- New
- Old (not implemented in Photon)
- Controversial (not implemented in Photon)
## Public Instances
Want your instance added here? Make a GitHub issue or make a PR! (this is for general purpose Photon instances.)
[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 | [photon@xylight.dev](mailto:photon@xylight.dev) |
| [ph.opnxng.com](https://ph.opnxng.com) | 🇸🇬 Singapore | [about.opnxng.com](https://about.opnxng.com) |
| [photon.thesanewriter.com](https://photon.thesanewriter.com) | 🇺🇸 US East | [thesanewriter@lemmy.thesanewriter.com](mailto:thesanewriter@lemmy.thesanewriter.com) |
| [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 | [zhenyapav@zhenyapav.com](mailto:zhenyapav@zhenyapav.com) |
| [~~ph.buckodr.ink~~ (Has not updated since v1.21.1)](https://ph.buckodr.ink) | 🇺🇸 US East | [admin@buckodr.ink](mailto:admin@buckodr.ink) |
| [phtn.ngn.tf](https://phtn.ngn.tf) | 🇹🇷 Turkey | [services@ngn.tf](mailto:services@ngn.tf)
## Donate
You can donate at [Buy me a Coffee](https://buymeacoffee.com/xylight)
<a href="https://www.buymeacoffee.com/xylight"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=xylight&button_colour=FFDD00&font_colour=000000&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" /></a>