Skip to content

Commit

Permalink
GITBOOK-1: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
realashleybailey authored and gitbook-bot committed Oct 2, 2023
1 parent fc45560 commit 101c4e7
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 113 deletions.
2 changes: 0 additions & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 3 additions & 7 deletions docs/contribute/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ If you want to contribute to Wizarr, here is how

1. Clone the repository with `git clone [email protected]: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
13 changes: 6 additions & 7 deletions docs/contribute/translate.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -40,6 +42,3 @@ docker run -d \
```
{% endtab %}
{% endtabs %}



26 changes: 14 additions & 12 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -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" %}
Expand All @@ -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:
Expand All @@ -52,9 +57,6 @@ Then, restart all services defined in the Compose file:

<pre class="language-docker"><code class="lang-docker"><strong>docker run -d \
</strong> --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 \
Expand Down Expand Up @@ -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 `<ServerIP:HostPort>` 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`.
12 changes: 5 additions & 7 deletions docs/getting-started/reverse-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ server {
set $upstream_proto http;
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
}
}
```
{% endtab %}

{% 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
Expand Down Expand Up @@ -151,7 +151,5 @@ plex.example.com {
reverse_proxy http://127.0.0.1:5055
}
```


{% endtab %}
{% endtabs %}
{% endtabs %}
4 changes: 4 additions & 0 deletions docs/using-wizarr/custom-html.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
39 changes: 0 additions & 39 deletions docs/using-wizarr/discord-integration.md

This file was deleted.

10 changes: 5 additions & 5 deletions docs/using-wizarr/requests-integration.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
description: BETA ONLY FEATURE
---

# Requests Integration

{% hint style="warning" %}
OLD DOCUMENTATION
{% endhint %}

### Setup

**Jellyseerr**
Expand All @@ -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.&#x20;
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.
Expand Down
34 changes: 0 additions & 34 deletions docs/using-wizarr/single-sign-on-sso.md

This file was deleted.

0 comments on commit 101c4e7

Please sign in to comment.