mirror of
https://github.com/stashapp/Stash-Docs.git
synced 2026-05-31 18:57:42 -05:00
Fix Typos (#122)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Contributing
|
||||
|
||||
Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs structure, look through [their documentation](https://squidfunk.github.io/mkdocs-material) for general idea for how it's structured and handy references.
|
||||
Pull requests are welcome. If you are unfamiliar with MkDocs/Material for MkDocs structure, look through [their documentation](https://squidfunk.github.io/mkdocs-material) for general idea for how it's structured and handy references.
|
||||
|
||||
## Contributing from the site via edit button
|
||||
|
||||
|
||||
@@ -65,11 +65,11 @@ If you haven't set up StashDB in your Stash settings yet, now's the time to do i
|
||||
|
||||
1. Go to the **Settings** page in Stash ([http://localhost:9999/settings](http://localhost:9999/settings){:target="_blank"} by default), click **Metadata Providers** on the left side and find **Stash-box Endpoints** at the top.
|
||||
|
||||
1. Click **Add** and fill out the form that pops up: paste in your API key you created earlier amd enter `ThePornDB` (or anything else you'd like, like TPDB) for **Name**, and enter `https://theporndb.net/graphql` as the **GraphQL endpoint**.
|
||||
1. Click **Add** and fill out the form that pops up: paste in your API key you created earlier and enter `ThePornDB` (or anything else you'd like, like TPDB) for **Name**, and enter `https://theporndb.net/graphql` as the **GraphQL endpoint**.
|
||||
|
||||
1. Click **Test Credentials** to make sure you've entered everything correctly, then click **Confirm**.
|
||||
|
||||
1. Finally, we can use the Scene Tagger to scrape from ThePornDB. First you'll need to switch to "ThePornDB" as the Tagger's source. It will always default to the first Stash-Box source, so you'll need to switch it every time you need something else. Use the same process here as [we used with StashDB and the Scene Tagger](#use-the-scene-tagger). The "Scrape All" and "Scrape by fragment" buttons will match by using file hashes (pHash and oshash). If these don't give you the right results, you can try the "Search" button and customize your search terms as needed. Remember to use as few terms as possible in your search because unneccessary words that don't match ThePornDB's info may block correct results. You can also copy-paste additional terms from TPDB's page if you need to narrow down the Tagger's results more.
|
||||
1. Finally, we can use the Scene Tagger to scrape from ThePornDB. First you'll need to switch to "ThePornDB" as the Tagger's source. It will always default to the first Stash-Box source, so you'll need to switch it every time you need something else. Use the same process here as [we used with StashDB and the Scene Tagger](#use-the-scene-tagger). The "Scrape All" and "Scrape by fragment" buttons will match by using file hashes (pHash and oshash). If these don't give you the right results, you can try the "Search" button and customize your search terms as needed. Remember to use as few terms as possible in your search because unnecessary words that don't match ThePornDB's info may block correct results. You can also copy-paste additional terms from TPDB's page if you need to narrow down the Tagger's results more.
|
||||
|
||||

|
||||
<br/><br/>
|
||||
|
||||
@@ -100,7 +100,7 @@ The URL of a HTTP(S) proxy to be used when stash makes calls to online services.
|
||||
|
||||
### no proxy
|
||||
|
||||
A list of domains for which the proxy must not be used. Default is all local LAN `localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12_`
|
||||
A list of domains for which the proxy must not be used. Default is all local LAN `localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12`
|
||||
|
||||
| Key | Value |
|
||||
|----------------------------|--------------|
|
||||
|
||||
@@ -17,7 +17,7 @@ See [issue 134](https://github.com/stashapp/stash/pull/134){:target="_blank"} fo
|
||||
|
||||
## Using a URL prefix
|
||||
|
||||
Stash also supports running under a URL prefix, in which case the the `X-Forwarded-Prefix` header must also be set. The proxy also needs to remove the prefix from the requested URLs. For example, if you want your homepage to be accessible at `http://example.domain.com/stash`, then you need to set `X-Forwarded-Prefix: /stash`.
|
||||
Stash also supports running under a URL prefix, in which case the `X-Forwarded-Prefix` header must also be set. The proxy also needs to remove the prefix from the requested URLs. For example, if you want your homepage to be accessible at `http://example.domain.com/stash`, then you need to set `X-Forwarded-Prefix: /stash`.
|
||||
|
||||
## Setting External URL
|
||||
|
||||
@@ -47,7 +47,7 @@ location / {
|
||||
|
||||
### Nginx + Docker (Linuxserver Letsencrypt)
|
||||
|
||||
If you are using the linuxserver letencrypt docker you can use create a `stash.subdomain.conf` file in your `proxy-confs` folder and use this as the config:
|
||||
If you are using the linuxserver letsencrypt docker you can use create a `stash.subdomain.conf` file in your `proxy-confs` folder and use this as the config:
|
||||
```bash
|
||||
# make sure that your dns has a cname set for stash
|
||||
|
||||
@@ -113,7 +113,7 @@ location /stash/ {
|
||||
|
||||
Another example for `nginx`:
|
||||
|
||||
In this case we are using `stash.home` as our domain and `192.168.0.1` is stash's ip so edit acccordingly.
|
||||
In this case we are using `stash.home` as our domain and `192.168.0.1` is stash's ip so edit accordingly.
|
||||
|
||||
The `external_host` configuration option should also be set, in this case `external_host: http://stash.home`. Refer to [external_host](https://github.com/stashapp/stash/pull/369){:target="_blank"} for more details.
|
||||
|
||||
@@ -199,11 +199,11 @@ The `external_host` configuration option should also be set, in this case `exter
|
||||
|
||||
### 504 Errors
|
||||
|
||||
- In some cases with big database files you might encounter `504` errors during stash db migration due to timeout. Adjusting the `proxy_read_timeout` value ( `proxy.conf` file in Letencrypt/Swag docker container)
|
||||
- In some cases with big database files you might encounter `504` errors during stash db migration due to timeout. Adjusting the `proxy_read_timeout` value ( `proxy.conf` file in Letsencrypt/Swag docker container)
|
||||
|
||||
### 422 Errors
|
||||
|
||||
- In order for the websocket to work, you may need to also add these lines to your server block (`proxy.conf` file in the Letencrypt Unraid docker container for instance) as mentioned [here](https://github.com/stashapp/stash/issues/532){:target="_blank"} should fix the issue.
|
||||
- In order for the websocket to work, you may need to also add these lines to your server block (`proxy.conf` file in the Letsencrypt Unraid docker container for instance) as mentioned [here](https://github.com/stashapp/stash/issues/532){:target="_blank"} should fix the issue.
|
||||
|
||||
```bash
|
||||
proxy_http_version 1.1;
|
||||
|
||||
@@ -21,7 +21,7 @@ The stash Docker container ships with everything you need to automatically run s
|
||||
|
||||
- No hardware acceleration support
|
||||
- No Python manager included
|
||||
- Full ARM compatability
|
||||
- Full ARM compatibility
|
||||
|
||||
### Docker Compose
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Synology
|
||||
icon: simple/synology
|
||||
---
|
||||
|
||||
!!! info "Writen by [Muldec](https://github.com/Muldec){:target="_blank"}."
|
||||
!!! info "Written by [Muldec](https://github.com/Muldec){:target="_blank"}."
|
||||
|
||||
## Foreword
|
||||
|
||||
@@ -104,7 +104,7 @@ sudo ln -sf /var/packages/ffmpeg7/target/bin/ffmpeg /usr/local/bin/ffmpeg
|
||||
|
||||
### Download Stash
|
||||
|
||||
Download the lastest version of Stash and its checksum from GitHub
|
||||
Download the latest version of Stash and its checksum from GitHub
|
||||
|
||||
```bash
|
||||
# find what architecture your Synology is running on
|
||||
@@ -142,7 +142,7 @@ rm CHECKSUMS_SHA1
|
||||
Prepare a Python environment (for scrapers and plugins)
|
||||
|
||||
```bash
|
||||
python3.11 -m ensurepip --Update
|
||||
python3.11 -m ensurepip --upgrade
|
||||
python3.11 -m venv stash-env
|
||||
source stash-env/bin/activate
|
||||
pip3 install pipreqs
|
||||
|
||||
@@ -28,7 +28,7 @@ icon: simple/unraid
|
||||
|
||||
---
|
||||
|
||||
Modification of the stashapp/stash porn organizer with Hardware Acceleration and python dependency intallation
|
||||
Modification of the stashapp/stash porn organizer with Hardware Acceleration and python dependency installation
|
||||
|
||||
[:octicons-link-16: Source](https://github.com/stashapp/stash){:target="_blank"} ⋅ [:octicons-container-16: GitHub](https://github.com/feederbox826/stash-s6/pkgs/container/stash-s6){:target="_blank"} ⋅ [:fontawesome-solid-file-code: Template](https://github.com/feederbox826/unraid-templates/blob/main/feederbox826/stash-s6.xml){:target="_blank"} ⋅ [:material-help-circle: Support](https://forums.unraid.net/topic/177317-s6){:target="_blank"}
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ icon: fontawesome/brands/windows
|
||||
|
||||
!!! note
|
||||
Some Windows 11 versions might open Stash via Terminal instead of going to notification area. You can bypass that by running the program as administrator or [use a shortcut to run it via conhost.exe](https://github.com/stashapp/stash/issues/2598){:target="_blank"}.
|
||||
As a result of running as administrator Stash might fail to detect your Python installtion in PATH, so you need point it the correct way yourself after installation. In :fontawesome-solid-gear: **Settings** > **System** and under **Applications Paths** header set **Python Executable Path**.
|
||||
As a result of running as administrator Stash might fail to detect your Python installation in PATH, so you need point it the correct way yourself after installation. In :fontawesome-solid-gear: **Settings** > **System** and under **Applications Paths** header set **Python Executable Path**.
|
||||
|
||||
## Install
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ You can view the [detailed information about scrapers here](/in-app-manual/scrap
|
||||
|
||||
## Create your own
|
||||
|
||||
To create your own scraper, there is [detailed information about that as well](/in-app-manual/scraping/scraperdevelopment). Best way to start is to read the simple ones and understand how xpath works. The [XPath Cheetsheet](https://devhints.io/xpath){:target="_blank"} is quite useful in creating a .yml file. In Firefox you can use xpath search in "Web Developer Tools (F12)". The "search HTML" bar actually accepts xpath searches. You can use it to verify your xpath queries.
|
||||
To create your own scraper, there is [detailed information about that as well](/in-app-manual/scraping/scraperdevelopment). Best way to start is to read the simple ones and understand how xpath works. The [XPath Cheatsheet](https://devhints.io/xpath){:target="_blank"} is quite useful in creating a .yml file. In Firefox you can use xpath search in "Web Developer Tools (F12)". The "search HTML" bar actually accepts xpath searches. You can use it to verify your xpath queries.
|
||||
|
||||
## Contribution
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ title: Stash-box instances
|
||||
|
||||
---
|
||||
|
||||
[:octicons-link-16: Website](https://stashdb.org){:target="_blank"} ⋅ [:fontawesome-regular-file-lines: Guidelines](https://guidelines.stashdb.org){:target="_blank"} ⋅ [:fontawesome-brands-discourse: Forum](https://discourse.stahapp.cc){:target="_blank"} ⋅ [:simple-discord: Discord](https://discord.com/invite/2TsNFKt){:target="_blank"} ⋅ [:material-api: Endpoint `https://stashdb.org/graphql`]() ⋅ [:fontawesome-solid-unlock-keyhole: Join](https://guidelines.stashdb.org/docs/faq_getting-started/stashdb/accessing-stashdb){:target="_blank"}
|
||||
[:octicons-link-16: Website](https://stashdb.org){:target="_blank"} ⋅ [:fontawesome-regular-file-lines: Guidelines](https://guidelines.stashdb.org){:target="_blank"} ⋅ [:fontawesome-brands-discourse: Forum](https://discourse.stashapp.cc){:target="_blank"} ⋅ [:simple-discord: Discord](https://discord.com/invite/2TsNFKt){:target="_blank"} ⋅ [:material-api: Endpoint `https://stashdb.org/graphql`]() ⋅ [:fontawesome-solid-unlock-keyhole: Join](https://guidelines.stashdb.org/docs/faq_getting-started/stashdb/accessing-stashdb){:target="_blank"}
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ title: Other projects
|
||||
!!! info "Disclaimer"
|
||||
Community projects are created and maintained by the community and are not associated with the stashapp team.
|
||||
|
||||
Other projects are tools, extensions, and add‑ons created by members of the community that extend, integrate with, or automate parts of Stash or stsah-box.
|
||||
Other projects are tools, extensions, and add‑ons created by members of the community that extend, integrate with, or automate parts of Stash or stash-box.
|
||||
|
||||
If you need help, follow the project's own support instructions or contact the original creator.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user