Rename project to Nicolium
Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
This commit is contained in:
nicole mikołajczyk
@ -1,8 +1,8 @@
|
||||
# Installing pl-fe as Iceshrimp.NET frontend
|
||||
# Installing Nicolium as Iceshrimp.NET frontend
|
||||
|
||||
Iceshrimp.NET does not have built-in support for alternative frontends. However, there are ways to use `pl-fe` as the frontend for Iceshrimp.NET by rerouting specific requests using a reverse proxy like Nginx.
|
||||
Iceshrimp.NET does not have built-in support for alternative frontends. However, there are ways to use Nicolium as the frontend for Iceshrimp.NET by rerouting specific requests using a reverse proxy like Nginx.
|
||||
|
||||
While this is the only way to use some of Iceshrimp.NET-specific features with `pl-fe`, because of Iceshrimp.NET CORS configuration, remember that it doesn't have full feature parity with the default Iceshrimp.NET frontend. You might prefer using `pl-fe` [in standalone mode](./standalone.md) instead.
|
||||
While this is the only way to use some of Iceshrimp.NET-specific features with Nicolium, because of Iceshrimp.NET CORS configuration, remember that it doesn't have full feature parity with the default Iceshrimp.NET frontend. You might prefer using Nicolium [in standalone mode](./standalone.md) instead.
|
||||
|
||||
## Example Nginx configuration
|
||||
|
||||
@ -13,7 +13,7 @@ map $http_upgrade $connection_upgrade {
|
||||
}
|
||||
|
||||
map "$http_accept,$http_content_type" $maybe_activitypub {
|
||||
default @plfe;
|
||||
default @nicolium;
|
||||
|
||||
"~application/json" @shrimp;
|
||||
"~application/activity\+json" @shrimp;
|
||||
@ -37,7 +37,7 @@ server {
|
||||
try_files /dev/null $maybe_activitypub;
|
||||
}
|
||||
|
||||
location @plfe {
|
||||
location @nicolium {
|
||||
try_files /index.html /dev/null;
|
||||
}
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Installing pl-fe as Mitra frontend
|
||||
# Installing Nicolium as Mitra frontend
|
||||
|
||||
Installing `pl-fe` as a frontend for Mitra is no different from installing the default Mitra Web frontend. Just extract the `pl-fe` files into the directory specified in `config.yaml` under `web_client_dir`, by default `/usr/share/mitra/www`.
|
||||
Installing Nicolium as a frontend for Mitra is no different from installing the default Mitra Web frontend. Just extract the Nicolium files into the directory specified in `config.yaml` under `web_client_dir`, by default `/usr/share/mitra/www`.
|
||||
|
||||
```bash
|
||||
curl -O https://pl.mkljczk.pl/pl-fe.zip
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# Installing pl-fe as Pleroma/Akkoma frontend
|
||||
# Installing Nicolium as Pleroma/Akkoma frontend
|
||||
|
||||
## Installation in instance static directory
|
||||
|
||||
The most straightforward way to install `pl-fe` as a frontend for Pleroma or Akkoma is to simply download it and place its files in the `/instance/static` directory of your Pleroma/Akkoma installation (usually `/opt/pleroma/instance/static` or `/opt/akkoma/instance/static`, accordingly).
|
||||
The most straightforward way to install Nicolium as a frontend for Pleroma or Akkoma is to simply download it and place its files in the `/instance/static` directory of your Pleroma/Akkoma installation (usually `/opt/pleroma/instance/static` or `/opt/akkoma/instance/static`, accordingly).
|
||||
|
||||
```bash
|
||||
curl -O https://pl.mkljczk.pl/pl-fe.zip
|
||||
@ -12,9 +12,9 @@ rm pl-fe.zip
|
||||
|
||||
## Installation via Pleroma/Akkoma frontend management
|
||||
|
||||
It is also possible to use the Pleroma frontend management tool. You can find more information about it in the [Pleroma documentation](https://docs.pleroma.social/backend/administration/frontends-management/). On Pleroma, you can use either the PleromaFE built-in admin dashboard or the older AdminFE to install `pl-fe` and set it as the server frontend. You don't have to provide any URL. It's right there in Pleroma.
|
||||
It is also possible to use the Pleroma/Akkoma frontend management tool. You can find more information about it in the [Pleroma documentation](https://docs.pleroma.social/backend/administration/frontends-management/). You can use either the PleromaFE built-in admin dashboard or the older AdminFE to install Nicolium and set it as the server frontend. You don't have to provide any URL. It's right there in Pleroma/Akkoma.
|
||||
|
||||
On Akkoma, however, there is no `pl-fe` in the default available frontends list ([yet?](https://akkoma.dev/AkkomaGang/akkoma/pulls/945)). You can still install it, but you need to explicitly provide the URL to `pl-fe`. To install it from CLI, use:
|
||||
To install it from CLI, use:
|
||||
|
||||
### OTP
|
||||
```bash
|
||||
@ -27,7 +27,7 @@ On Akkoma, however, there is no `pl-fe` in the default available frontends list
|
||||
mix pleroma.frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir .
|
||||
```
|
||||
|
||||
It is now possible to set `pl-fe` as the primary frontend in the configuration file or via AdminFE:
|
||||
It is now possible to set Nicolium as the primary frontend in the configuration file or via AdminFE:
|
||||
```elixir
|
||||
config :pleroma, :frontends,
|
||||
primary: %{
|
||||
@ -37,4 +37,4 @@ config :pleroma, :frontends,
|
||||
...
|
||||
```
|
||||
|
||||
On Akkoma, it is also possible for individual users to select their preferred frontend to `pl-fe` by visiting `/akkoma/frontend` page on their Akkoma instance.
|
||||
On Akkoma, it is also possible for individual users to select their preferred frontend to Nicolium by visiting `/akkoma/frontend` page on their Akkoma instance.
|
||||
@ -1,16 +1,16 @@
|
||||
# Standalone pl-fe installation
|
||||
# Standalone Nicolium installation
|
||||
|
||||
To install `pl-fe` in standalone mode, allowing to sign in to any instance implementing Mastodon client API, you only need a static web server to serve the files. As usual on single page applications with client-side routing, the server must be configured to fallback to `index.html` for non-matching routes.
|
||||
To install Nicolium in standalone mode, allowing to sign in to any instance implementing Mastodon client API, you only need a static web server to serve the files. As usual on single page applications with client-side routing, the server must be configured to fallback to `index.html` for non-matching routes.
|
||||
|
||||
## Example Caddy configuration
|
||||
|
||||
```caddy
|
||||
pl-fe.example.com {
|
||||
root * /var/www/pl-fe
|
||||
nicolium.example.com {
|
||||
root * /var/www/nicolium
|
||||
encode
|
||||
try_files {path} /index.html
|
||||
file_server
|
||||
}
|
||||
```
|
||||
|
||||
This assumes you're serving `pl-fe` under the pl-fe.example.com domain and the `pl-fe` files are located in `/var/www/pl-fe`. You can download `pl-fe` from `https://pl.mkljczk.pl/pl-fe.zip` or [build it from source](../building/pl-fe.md).
|
||||
This assumes you're serving Nicolium under the nicolium.example.com domain and the Nicolium files are located in `/var/www/nicolium`. You can download Nicolium from `https://pl.mkljczk.pl/pl-fe.zip` or [build it from source](../building/nicolium.md).
|
||||
Reference in New Issue
Block a user