mirror of
https://github.com/stashapp/stash.git
synced 2025-12-06 08:26:00 +01:00
[Documentation] Replaces wiki links with new documentation site (#3352)
This commit is contained in:
DogmaDragon
GitHub
parent
639a9da65b
commit
515202d28e
9 changed files with 25 additions and 26 deletions
21
README.md
21
README.md
|
|
@ -26,7 +26,7 @@ For further information you can [read the in-app manual](ui/v2.5/src/docs/en).
|
|||
|
||||
## First Run
|
||||
#### Windows Users: Security Prompt
|
||||
Running the app might present a security prompt since the binary isn't yet signed. Bypass this by clicking "more info" and then the "run anyway" button.
|
||||
Running the app might present a security prompt since the binary isn't yet signed. Bypass this by clicking "more info" and then the "run anyway" button.
|
||||
#### FFMPEG
|
||||
Stash requires ffmpeg. If you don't have it installed, Stash will download a copy for you. It is recommended that Linux users install `ffmpeg` from their distro's package manager.
|
||||
|
||||
|
|
@ -39,32 +39,31 @@ On first run, Stash will prompt you for some configuration options and media dir
|
|||
|
||||
Stash can pull metadata (performers, tags, descriptions, studios, and more) directly from many sites through the use of [scrapers](https://github.com/stashapp/stash/tree/develop/ui/v2.5/src/docs/en/Scraping.md), which integrate directly into Stash.
|
||||
|
||||
Many community-maintained scrapers are available for download at the [Community Scrapers Collection](https://github.com/stashapp/CommunityScrapers). The community also maintains StashDB, a crowd-sourced repository of scene, studio, and performer information, that can automatically identify much of a typical media collection. Inquire in the Discord for details. Identifying an entire collection will typically require a mix of multiple sources.
|
||||
Many community-maintained scrapers are available for download from [CommunityScrapers repository](https://github.com/stashapp/CommunityScrapers). The community also maintains StashDB, a crowd-sourced repository of scene, studio, and performer information, that can automatically identify much of a typical media collection. Inquire in the Discord for details. Identifying an entire collection will typically require a mix of multiple sources.
|
||||
|
||||
<sub>StashDB is the canonical instance of our open source metadata API, [stash-box](https://github.com/stashapp/stash-box).</sub>
|
||||
<sub>[StashDB](http://stashdb.org) is the canonical instance of our open source metadata API, [stash-box](https://github.com/stashapp/stash-box).</sub>
|
||||
|
||||
# Translation
|
||||
[](https://translate.stashapp.cc/engage/stash/)
|
||||
🇧🇷 🇨🇳 🇩🇰 🇳🇱 🇬🇧 🇪🇪 🇫🇮 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇵🇱 🇷🇺 🇪🇸 🇸🇪 🇹🇼 🇹🇷
|
||||
|
||||
Stash is available in 18 languages (so far!) and it could be in your language too. If you want to help us translate Stash into your language, you can make an account at [translate.stashapp.cc](https://translate.stashapp.cc/projects/stash/stash-desktop-client/) to get started contributing new languages or improving existing ones. Thanks!
|
||||
Stash is available in 25 languages (so far!) and it could be in your language too. If you want to help us translate Stash into your language, you can make an account at [translate.stashapp.cc](https://translate.stashapp.cc/projects/stash/stash-desktop-client/) to get started contributing new languages or improving existing ones. Thanks!
|
||||
|
||||
# Support (FAQ)
|
||||
|
||||
Answers to other Frequently Asked Questions can be found [on our Wiki](https://github.com/stashapp/stash/wiki/FAQ)
|
||||
Check out our documentation on [Stash-Docs](https://docs.stashapp.cc) for information about the software, questions, guides, add-ons and more.
|
||||
|
||||
For issues not addressed there, there are a few options.
|
||||
|
||||
* Read the [Wiki](https://github.com/stashapp/stash/wiki)
|
||||
* Check the in-app documentation, in the top right corner of the app (also available [here](https://github.com/stashapp/stash/tree/develop/ui/v2.5/src/docs/en)
|
||||
For more help you can:
|
||||
* Check the in-app documentation, in the top right corner of the app (it's also mirrored on [Stash-Docs](https://docs.stashapp.cc/docs/In-app-Manual/)
|
||||
* Join the [Discord server](https://discord.gg/2TsNFKt), where the community can offer support.
|
||||
* Start a [discussion on GitHub](https://github.com/stashapp/stash/discussions)
|
||||
|
||||
# Customization
|
||||
|
||||
## Themes and CSS Customization
|
||||
There is a [directory of community-created themes](https://github.com/stashapp/stash/wiki/Themes) on our Wiki, along with instructions on how to install them.
|
||||
There is a [directory of community-created themes](https://docs.stashapp.cc/docs/User-Interface-UI/Themes/) on Stash-Docs, along with instructions on how to install them.
|
||||
|
||||
You can also make Stash interface fit your desired style with [Custom CSS snippets](https://github.com/stashapp/stash/wiki/Custom-CSS-snippets).
|
||||
You can also change the Stash interface to fit your desired style with various snippets from [Custom CSS snippets](https://docs.stashapp.cc/docs/User-Interface-UI/Custom-CSS-Snippets/).
|
||||
|
||||
# For Developers
|
||||
|
||||
|
|
|
|||
|
|
@ -17,12 +17,12 @@ const loginEndPoint = "/login"
|
|||
|
||||
const (
|
||||
tripwireActivatedErrMsg = "Stash is exposed to the public internet without authentication, and is not serving any more content to protect your privacy. " +
|
||||
"More information and fixes are available at https://github.com/stashapp/stash/wiki/Authentication-Required-When-Accessing-Stash-From-the-Internet"
|
||||
"More information and fixes are available at https://docs.stashapp.cc/docs/Network/Authentication-Required-When-Accessing-Stash-From-the-Internet/"
|
||||
|
||||
externalAccessErrMsg = "You have attempted to access Stash over the internet, and authentication is not enabled. " +
|
||||
"This is extremely dangerous! The whole world can see your your stash page and browse your files! " +
|
||||
"Stash is not answering any other requests to protect your privacy. " +
|
||||
"Please read the log entry or visit https://github.com/stashapp/stash/wiki/Authentication-Required-When-Accessing-Stash-From-the-Internet"
|
||||
"Please read the log entry or visit https://docs.stashapp.cc/docs/Network/Authentication-Required-When-Accessing-Stash-From-the-Internet/"
|
||||
)
|
||||
|
||||
func allowUnauthenticated(r *http.Request) bool {
|
||||
|
|
|
|||
|
|
@ -1265,7 +1265,7 @@ func (i *Instance) GetDefaultGenerateSettings() *models.GenerateMetadataOptions
|
|||
}
|
||||
|
||||
// GetDangerousAllowPublicWithoutAuth determines if the security feature is enabled.
|
||||
// See https://github.com/stashapp/stash/wiki/Authentication-Required-When-Accessing-Stash-From-the-Internet
|
||||
// See https://docs.stashapp.cc/docs/Network/Authentication-Required-When-Accessing-Stash-From-the-Internet/
|
||||
func (i *Instance) GetDangerousAllowPublicWithoutAuth() bool {
|
||||
return i.getBool(dangerousAllowPublicWithoutAuth)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -81,6 +81,6 @@ func LogExternalAccessError(err ExternalAccessError) {
|
|||
"You probably forwarded a port from your router. At the very least, add a password to stash in the settings. \n"+
|
||||
"Stash will not serve requests until you edit config.yml, remove the security_tripwire_accessed_from_public_internet key and restart stash. \n"+
|
||||
"This behaviour can be overridden (but not recommended) by setting dangerous_allow_public_without_auth to true in config.yml. \n"+
|
||||
"More information is available at https://github.com/stashapp/stash/wiki/Authentication-Required-When-Accessing-Stash-From-the-Internet \n"+
|
||||
"More information is available at https://docs.stashapp.cc/docs/Network/Authentication-Required-When-Accessing-Stash-From-the-Internet/ \n"+
|
||||
"Stash is not answering any other requests to protect your privacy.", net.IP(err).String())
|
||||
}
|
||||
|
|
|
|||
|
|
@ -108,11 +108,11 @@ export const SettingsAboutPanel: React.FC = () => {
|
|||
{
|
||||
url: (
|
||||
<a
|
||||
href="https://github.com/stashapp/stash/wiki"
|
||||
href="https://docs.stashapp.cc"
|
||||
rel="noopener noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
Wiki
|
||||
Stash-Docs
|
||||
</a>
|
||||
),
|
||||
}
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ export const SettingsLibraryPanel: React.FC = () => {
|
|||
id: "config.general.excluded_video_patterns_desc",
|
||||
})}
|
||||
<a
|
||||
href="https://github.com/stashapp/stash/wiki/Exclude-file-configuration"
|
||||
href="https://docs.stashapp.cc/docs/Beginner-Guides/Exclude-File-Configuration/"
|
||||
rel="noopener noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
|
|
@ -104,7 +104,7 @@ export const SettingsLibraryPanel: React.FC = () => {
|
|||
id: "config.general.excluded_image_gallery_patterns_desc",
|
||||
})}
|
||||
<a
|
||||
href="https://github.com/stashapp/stash/wiki/Exclude-file-configuration"
|
||||
href="https://docs.stashapp.cc/docs/Beginner-Guides/Exclude-File-Configuration/"
|
||||
rel="noopener noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
|
|
|
|||
|
|
@ -2,6 +2,6 @@
|
|||
|
||||
Join our [Discord](https://discord.gg/2TsNFKt).
|
||||
|
||||
The [Github wiki](https://github.com/stashapp/stash/wiki) covers some areas not covered in the in-app help.
|
||||
The [Stash-Docs](https://docs.stashapp.cc) covers some areas not covered in the in-app help.
|
||||
|
||||
Raise a [github issue](https://github.com/stashapp/stash/issues).
|
||||
Raise a [GitHub issue](https://github.com/stashapp/stash/issues).
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ By default, when a scene has a resume point, the scene player will automatically
|
|||
|
||||
## Custom CSS
|
||||
|
||||
The stash UI can be customised using custom CSS. See [here](https://github.com/stashapp/stash/wiki/Custom-CSS-snippets) for a community-curated set of CSS snippets to customise your UI.
|
||||
The stash UI can be customised using custom CSS. See [here](https://docs.stashapp.cc/docs/User-Interface-UI/Custom-CSS-Snippets/) for a community-curated set of CSS snippets to customise your UI.
|
||||
|
||||
[Stash Plex Theme](https://github.com/stashapp/stash/wiki/Theme-Plex) is a community created theme inspired by the popular Plex interface.
|
||||
[Stash Plex Theme](https://docs.stashapp.cc/docs/User-Interface-UI/Themes/Theme-Plex/) is a community created theme inspired by the popular Plex interface.
|
||||
|
||||
## Custom Javascript
|
||||
|
||||
|
|
|
|||
|
|
@ -218,7 +218,7 @@ For those preferring the json-format, defined [here](https://json-schema.org/),
|
|||
``` json
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://github.com/stashapp/stash/wiki/JSON-Specification/performer.json",
|
||||
"$id": "https://docs.stashapp.cc/docs/In-app-Manual/Tasks/JSONSpec/#performerjson",
|
||||
"title": "performer",
|
||||
"description": "A json file representing a performer. The file is named by a MD5 Code.",
|
||||
"type": "object",
|
||||
|
|
@ -318,7 +318,7 @@ For those preferring the json-format, defined [here](https://json-schema.org/),
|
|||
``` json
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://github.com/stashapp/stash/wiki/JSON-Specification/studio.json",
|
||||
"$id": "https://docs.stashapp.cc/docs/In-app-Manual/Tasks/JSONSpec/#studiojson",
|
||||
"title": "studio",
|
||||
"description": "A json file representing a studio. The file is named by a MD5 Code.",
|
||||
"type": "object",
|
||||
|
|
@ -357,7 +357,7 @@ For those preferring the json-format, defined [here](https://json-schema.org/),
|
|||
```json
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://github.com/stashapp/stash/wiki/JSON-Specification/scene.json",
|
||||
"$id": "https://docs.stashapp.cc/docs/In-app-Manual/Tasks/JSONSpec/#scenejson",
|
||||
"title": "scene",
|
||||
"description": "A json file representing a scene. The file is named by the MD5 Code of the file its data is referring to.",
|
||||
"type": "object",
|
||||
|
|
|
|||
Loading…
Reference in a new issue