From 101c4e7a45351c3de6f927b6132ba71d073cdb6c Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Mon, 2 Oct 2023 15:57:45 +0000 Subject: [PATCH] GITBOOK-1: change request with no subject merged in GitBook --- docs/SUMMARY.md | 2 -- docs/contribute/development.md | 10 ++---- docs/contribute/translate.md | 13 ++++---- docs/getting-started/installation.md | 26 ++++++++------- docs/getting-started/reverse-proxy.md | 12 +++---- docs/using-wizarr/custom-html.md | 4 +++ docs/using-wizarr/discord-integration.md | 39 ----------------------- docs/using-wizarr/requests-integration.md | 10 +++--- docs/using-wizarr/single-sign-on-sso.md | 34 -------------------- 9 files changed, 37 insertions(+), 113 deletions(-) delete mode 100644 docs/using-wizarr/discord-integration.md delete mode 100644 docs/using-wizarr/single-sign-on-sso.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 3282ac040..227840bcc 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -9,10 +9,8 @@ ## 💭 Using Wizarr -* [Single-Sign-On (SSO)](using-wizarr/single-sign-on-sso.md) * [Custom HTML](using-wizarr/custom-html.md) * [Requests Integration](using-wizarr/requests-integration.md) -* [Discord Integration](using-wizarr/discord-integration.md) ## ⛑ Support diff --git a/docs/contribute/development.md b/docs/contribute/development.md index 16edd5ae3..7d1cf9c1e 100644 --- a/docs/contribute/development.md +++ b/docs/contribute/development.md @@ -10,10 +10,6 @@ If you want to contribute to Wizarr, here is how 1. Clone the repository with `git clone git@github.com:Wizarrrr/wizarr.git` 2. Move into the directory `cd wizarr` -3. (Optional but recommended) Create a python virtual environment with `python -m venv venv` -4. Enter the python venv with `source venv/bin/activate` -5. Install dependencies with `pip install -r requirements.txt` -6. Install static dependencies with `cd app/static && npm install && cd ../..` -7. Build static files with `cd app/static && npm run build && cd ../..` -8. Start Wizarr with `APP_URL=127.0.0.1:5000 flask run --debug run` -9. Wizarr is now accessible at http://127.0.0.1:5000 +3. Please use VSCode and open the `wizarr.code-workspace` file under File->Open Worspace from File +4. Then inside the Run and Debug panel of VSCode run the `Run All (workspace)` +5. Then you can visit http://localhost:5173 diff --git a/docs/contribute/translate.md b/docs/contribute/translate.md index 5b24903b6..fb23b4e91 100644 --- a/docs/contribute/translate.md +++ b/docs/contribute/translate.md @@ -1,18 +1,20 @@ # Translate +{% hint style="warning" %} +TRANSLATIONS CURRENTLY NOT BEING ACCEPTED +{% endhint %} + Thanks for your interest in contributing to Wizarr! ### Weblate -We use Weblate to help translate Wizarr! +We use Weblate to help translate Wizarr! {% embed url="https://hosted.weblate.org/engage/wizarr/" %} - - ### Testing Translations -After you have saved a translation, it will be pushed to the `master` branch directly. The `dev` docker image will then be automatically compiled shortly thereafter. +After you have saved a translation, it will be pushed to the `master` branch directly. The `dev` docker image will then be automatically compiled shortly thereafter. To test it out, simply add the `dev` label to the Docker Image, and you can use the `FORCE_LANGUAGE` environment variable to force a language to Wizarr. @@ -40,6 +42,3 @@ docker run -d \ ``` {% endtab %} {% endtabs %} - - - diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 5f3d14c62..abfa03e9e 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,5 +1,15 @@ +--- +description: Install Wizarr using Docker or Compose +--- + # Installation +{% hint style="info" %} +We have recently updated from V2 to V3, this has many improvements and features however V2 will always be available, however we won't be able to provide updates and support for V2, to use V2 visit it below. + +[View Documentation](https://github.com/Wizarrrr/wizarr/tree/v2) +{% endhint %} + ### Docker {% hint style="warning" %} @@ -21,15 +31,10 @@ services: wizarr: container_name: wizarr image: ghcr.io/wizarrrr/wizarr - #user: 1000:1000 #Optional but recommended, sets the user uid that Wizarr will run with ports: - 5690:5690 volumes: - /path/to/appdata/config:/data/database - environment: - - APP_URL=https://wizarr.domain.com #URL at which you will access and share - - DISABLE_BUILTIN_AUTH=false #Set to true ONLY if you are using another auth provider (Authelia, Authentik, etc) - - TZ=Europe/London #Set your timezone here ``` Then, start all services defined in the Compose file: @@ -52,9 +57,6 @@ Then, restart all services defined in the Compose file: 
docker run -d \
   --name wizarr \
-  -e APP_URL=https://wizarr.domain.com \
-  -e DISABLE_BUILTIN_AUTH=false \
-  -e TZ=Europe/London \
   -p 5690:5690 \
   -v /path/to/appdata/config:/data/database \
   --restart unless-stopped \
@@ -85,12 +87,12 @@ docker run -d ...
 
 ## Unraid
 
+{% hint style="warning" %}
+NOT IMPLEMENTED YET
+{% endhint %}
+
 1. Ensure you have the **Community Applications** plugin installed.
 2. Inside the **Community Applications** app store, search for **Wizarr**.
 3. Click the **Install Button**.
 4. On the following **Add Container** screen, make changes to the **Host Port** and **Host Path 1**(Appdata) as needed, as well as the environment variables.
 5. Click apply and access "Wizarr" at your `` in a web browser.
-
-## Beta
-
-To use the current Wizarr V3 beta, please follow the above Docker Compose or Docker CLI steps replacing your image with `ghcr.io/wizarrrr/wizarr:v3-alpha`.
diff --git a/docs/getting-started/reverse-proxy.md b/docs/getting-started/reverse-proxy.md
index ba741db85..7eb35bb7c 100644
--- a/docs/getting-started/reverse-proxy.md
+++ b/docs/getting-started/reverse-proxy.md
@@ -25,7 +25,6 @@ server {
         set $upstream_proto http;
         proxy_pass $upstream_proto://$upstream_app:$upstream_port;
     }
-
 }
 ```
 {% endtab %}
@@ -33,16 +32,17 @@ server {
 {% tab title="Nginx Proxy Manager" %}
 Add a new proxy host with the following settings:
 
-#### Details
+**Details**
 
 * **Domain Names:** Your desired external wizarr hostname; e.g., `wizarr.example.com`
 * **Scheme:** `http`
 * **Forward Hostname / IP:** Internal wizarr hostname or IP
 * **Forward Port:** `5690`
 * **Cache Assets:** yes
-* **Block Common Exploits:** no 
+* **Block Common Exploits:** yes
+* **Websocket Support:** yes
 
-#### SSL
+**SSL**
 
 * **SSL Certificate:** Select one of the options; if you are not sure, pick “Request a new SSL Certificate”
 * **Force SSL:** yes
@@ -151,7 +151,5 @@ plex.example.com {
     reverse_proxy http://127.0.0.1:5055
 }
 ```
-
-
 {% endtab %}
-{% endtabs %}
\ No newline at end of file
+{% endtabs %}
diff --git a/docs/using-wizarr/custom-html.md b/docs/using-wizarr/custom-html.md
index bcd4a5689..a138496a5 100644
--- a/docs/using-wizarr/custom-html.md
+++ b/docs/using-wizarr/custom-html.md
@@ -1,5 +1,9 @@
 # Custom HTML
 
+{% hint style="warning" %}
+NOT YET IMPLEMENTED
+{% endhint %}
+
 With the ability to add a custom HTML section to the setup wizard for Plex and Jellyfin, you can create a custom page that will be automatically centred and placed in a div with a background, making it a seamless addition to your setup process
 
 ### Adding Custom HTML
diff --git a/docs/using-wizarr/discord-integration.md b/docs/using-wizarr/discord-integration.md
deleted file mode 100644
index 9eda2e9e6..000000000
--- a/docs/using-wizarr/discord-integration.md
+++ /dev/null
@@ -1,39 +0,0 @@
----
-description: BETA ONLY FEATURE
----
-
-# Discord Integration
-
-#### Find your Discord Server ID
-
-1. In Discord, go to your **Server Settings**
-2. Select the **Widget** tab
-3. Enable Server Widget
-4. Choose an Invite Channel (`general` for example)
-5. Copy your **Server ID**
-
-#### Toggle the Discord Widget
-
-Wizarr supports using either the standard Discord widget, or a custom widget utilizing the Discord API. The custom widget is enabled by default, and provides a more integrated look and feel, however if this is not desired you can toggle the standard widget on in Wizarr's settings.
-
-{% hint style="warning" %}
-If your Discord information is not showing, this maybe because Discord has flagged your IP for too many requests. Please try again later.
-{% endhint %}
-
-{% tabs %}
-{% tab title="Custom Widget" %}
-
Custom Discord Widget

-{% endtab %}
-
-{% tab title="Standard Widget" %}
-
Standard Discord Widget

-{% endtab %}
-{% endtabs %}
-
-{% hint style="info" %}
-**Why not use an invitation link?**
-
-Enabling the widget and the invite channel makes the Discord API dynamically generate an invitation link for the purpose of the widget.
-
-This means that to use this integration, you don't need to generate a Never expiring invitation, which some users might want to avoid.
-{% endhint %}
diff --git a/docs/using-wizarr/requests-integration.md b/docs/using-wizarr/requests-integration.md
index 511f4b612..21a439a26 100644
--- a/docs/using-wizarr/requests-integration.md
+++ b/docs/using-wizarr/requests-integration.md
@@ -1,9 +1,9 @@
----
-description: BETA ONLY FEATURE
----
-
 # Requests Integration
 
+{% hint style="warning" %}
+OLD DOCUMENTATION
+{% endhint %}
+
 ### Setup
 
 **Jellyseerr**
@@ -26,7 +26,7 @@ description: BETA ONLY FEATURE
 
 1. Go to your Ombi settings, then click "Configuration" and select "General" from the dropdown.
 2. Copy the API key from the "API Key" field.
-3. Go to your Wizarr settings then Requests. 
+3. Go to your Wizarr settings then Requests.
 4. Select Ombi from the dropdown.
 5. Input your Ombi base URL.
 6. Input your Ombi API key.
diff --git a/docs/using-wizarr/single-sign-on-sso.md b/docs/using-wizarr/single-sign-on-sso.md
deleted file mode 100644
index d05c083a7..000000000
--- a/docs/using-wizarr/single-sign-on-sso.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# Single-Sign-On (SSO)
-
-#### **Wizarr supports SSO via disabling its inbuilt authentication**
-
-To Disable Wizarr's inbuilt authentication in order to put it behind a Proxy Provider (Authelia, Authentik...), set the following variable:
-
-`DISABLE_BUILTIN_AUTH=True`
-
-#### Whitelist Public Paths (important!)
-
-In order to make the invitation process available for non signed in users, make sure you whitelist the following paths:
-
-{% tabs %}
-{% tab title="Authelia" %}
-```
-    - domain: wizarr.domain.com
-      resources:
-        - '^/j/'
-        - '^/join/'
-        - '^/setup/*'
-        - '^/static/'
-      policy: bypass
-```
-{% endtab %}
-
-{% tab title="Authentik/Other" %}
-```
-- '^/j/'
-- '^/join/'
-- '^/setup/*'
-- '^/static/'
-```
-{% endtab %}
-{% endtabs %}