Infrastructure/pingvin-share
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2025-02-19 01:55:48 -05:00
Code Issues Activity

docs(installation): Add Portainer installation and upgrade steps (#651)

Browse source 
* Change general config icon

* Update package.json

* Add portainer installation documentation

---------

Co-authored-by: Elias Schneider <login@eliasschneider.com>
This commit is contained in:
edbourque0 2024-10-18 14:56:14 -04:00 • committed by GitHub
parent 08079744a0
commit 6444a9d553
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docs/setup/installation.md
View file

@ -11,6 +11,16 @@ id: installation
The website is now listening on `http://localhost:3000`, have fun with Pingvin Share 🐧!
### Installation with Portainer
1. In the **Stacks** menu, click the **Add stack** button
2. Give you stack a name (ex. pingvinshare)
3. In the web editor, paste the content of the [docker-compose](https://github.com/stonith404/pingvin-share/blob/main/docker-compose.yml) file.
4. Edit the external port and the environment variables (optional).
5. Click on **Deploy the stack**.
Your container is now listening on `http://localhost:<externalport>`, have fun with Pingvin Share 🐧!
### Stand-alone Installation
Required tools:

2
docs/docs/setup/oauth2login.md
View file

@ -40,7 +40,7 @@ Redirect URL: `https://<your-domain>/api/oauth/callback/discord`
### OpenID Connect
Generic OpenID Connect provider is also supported, we have tested it on Keycloak, Authentik and Casdoor.
Generic OpenID Connect provider is also supported, we have tested it on Keycloak, Authentik, Casdoor and [Pocket ID](https://github.com/stonith404/pocket-id).
Redirect URI: `https://<your-domain>/api/oauth/callback/oidc`

5
docs/docs/setup/upgrading.md
View file

@ -14,6 +14,11 @@ As Pingvin Share is in early stage, see the release notes for breaking changes b
docker compose pull
docker compose up -d
```
### Portainer
1. In your container page, click on Recreate.
2. Check the Re-Pull image toggle.
3. Click on Recreate.
#### Stand-alone