You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.yml
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,14 @@ labels: ["bug report"]
4
4
body:
5
5
- type: markdown
6
6
attributes:
7
-
value: |
8
-
Thanks for taking the time to fill out this bug report!
7
+
value: Thanks for taking the time to fill out this bug report! Make sure to read [Contributing](https://github.com/stashapp/stash/blob/develop/docs/CONTRIBUTING.md) document before submitting.
9
8
- type: checkboxes
10
9
id: confirm-troubleshooting
11
10
attributes:
12
11
label: Have you enabled troubleshooting mode?
13
12
description: |
14
-
To ensure the bug is not caused by custom modifications or plugins make sure to enable troubleshooting mode before filing the report. In Stash go to Settings and click **Troubleshooting mode** and then retest to see if the bug still occurs.
13
+
To ensure the bug is not caused by custom modifications or plugins make sure to enable troubleshooting mode before filing the report. In Stash go to Settings and click **Troubleshooting mode** and then retest to see if the bug still occurs.
14
+
It's important to note that troubleshooting mode only affects UI modifications and plugins.
15
15
options:
16
16
- label: I confirm that the troubleshooting mode is enabled.
17
17
required: true
@@ -56,13 +56,13 @@ body:
56
56
placeholder: (e.g. v0.28.1)
57
57
validations:
58
58
required: true
59
-
- type: input
59
+
- type: textarea
60
60
id: devicedetails
61
61
attributes:
62
62
label: Device details
63
63
description: |
64
-
If this is an issue that occurs when using the Stash interface, please provide details of the device/browser used which presents the reported issue.
65
-
placeholder: (e.g. Firefox 97 (64-bit) on Windows 11)
64
+
Please provide details about the device you are using, including the operating system and browser (if applicable).
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.yml
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,9 @@ name: Feature Request
2
2
description: Request a new feature or idea to be added to Stash
3
3
labels: ["feature request"]
4
4
body:
5
+
- type: markdown
6
+
attributes:
7
+
value: Thank you for taking the time to submit a feature request! Make sure to read [Contributing](https://github.com/stashapp/stash/blob/develop/docs/CONTRIBUTING.md) document before submitting.
[](https://github.com/stashapp/stash/releases/latest)
<h3>Stash is a self-hosted webapp written in Go which organizes and serves your diverse content collection, catering to both your SFW and NSFW needs.</h3>
13
14
@@ -20,9 +21,9 @@
20
21
21
22
You can [watch a SFW demo video](https://vimeo.com/545323354) to see it in action.
22
23
23
-
For further information you can consult the [documentation](https://docs.stashapp.cc) or access the in-app manual from within the application (also available at [docs.stashapp.cc/in-app-manual](https://docs.stashapp.cc/in-app-manual)).
24
+
For further information see [Support & Resources](#support--resources) section.
24
25
25
-
# Installing Stash
26
+
##Installing Stash
26
27
27
28
> [!tip]
28
29
Step-by-step instructions are available at [docs.stashapp.cc/installation](https://docs.stashapp.cc/installation/).
@@ -37,15 +38,15 @@ Step-by-step instructions are available at [docs.stashapp.cc/installation](https
37
38
>
38
39
> As of version 0.29.0, Stash requires _macOS 11 Big Sur_ or later.
39
40
> As of version 0.32.0, Stash requires _macOS 12 Monterey_ or later.
40
-
> Stash can still be run through Docker on older versions of macOS.
41
+
> Older versions can still be run through Docker.
41
42
42
43
<imgsrc="docs/readme_assets/windows_logo.svg"width="100%"height="75"> Windows | <imgsrc="docs/readme_assets/mac_logo.svg"width="100%"height="75"> macOS | <imgsrc="docs/readme_assets/linux_logo.svg"width="100%"height="75"> Linux | <imgsrc="docs/readme_assets/docker_logo.svg"width="100%"height="75"> Docker
Download links for other platforms and architectures are available on the [Releases](https://github.com/stashapp/stash/releases) page.
47
48
48
-
## First Run
49
+
###First Run
49
50
50
51
#### Windows/macOS Users: Security Prompt
51
52
@@ -58,69 +59,61 @@ On Windows or macOS, running the app might present a security prompt since the a
58
59
59
60
Stash requires FFmpeg. If you don't have it installed, Stash will prompt you to download a copy during setup. It is recommended that Linux users install `ffmpeg` from their distro's package manager.
60
61
61
-
# Usage
62
+
##Usage
62
63
63
-
## Quickstart Guide
64
+
###Quickstart Guide
64
65
65
66
Stash is a web-based application. Once the application is running, the interface is available (by default) from `http://localhost:9999`.
66
67
67
68
On first run, Stash will prompt you for some configuration options and media directories to index, called "Scanning" in Stash. After scanning, your media will be available for browsing, curating, editing, and tagging.
68
69
69
70
Stash can pull metadata (performers, tags, descriptions, studios, and more) directly from many sites through the use of [scrapers](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Scraping.md), which integrate directly into Stash. Identifying an entire collection will typically require a mix of multiple sources:
70
71
- The stashapp team maintains [StashDB](https://stashdb.org/), a crowd-sourced repository of scene, studio, and performer information. Connecting it to Stash will allow you to automatically identify much of a typical media collection. It runs on our stash-box software and is primarily focused on mainstream digital scenes and studios. Instructions, invite codes, and more can be found in this guide to [Accessing StashDB](https://guidelines.stashdb.org/docs/faq_getting-started/stashdb/accessing-stashdb/).
71
-
- Several community-managed stash-box databases can also be connected to Stash in a similar manner. Each one serves a slightly different niche and follows their own methodology. A rundown of each stash-box, their differences, and the information you need to sign up can be found in this guide to [Accessing Stash-Boxes](https://guidelines.stashdb.org/docs/faq_getting-started/stashdb/accessing-stash-boxes/).
72
+
- Several community-managed stash-box databases can also be connected to Stash in a similar manner. Each one serves a slightly different niche and follows their own methodology. A rundown of each stash-box, their differences, and the information you need to sign up can be found in the [Metadata Sources](https://docs.stashapp.cc/metadata-sources/stash-box-instances/) section of the documentation.
72
73
- Many community-maintained scrapers can also be downloaded, installed, and updated from within Stash, allowing you to pull data from a wide range of other websites and databases. They can be found by navigating to `Settings → Metadata Providers → Available Scrapers → Community (stable)`. These can be trickier to use than a stash-box because every scraper works a little differently. For more information, please visit the [CommunityScrapers repository](https://github.com/stashapp/CommunityScrapers).
73
74
- All of the above methods of scraping data into Stash are also covered in more detail in our [Guide to Scraping](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/).
74
75
75
76
<sub>[StashDB](http://stashdb.org) is the canonical instance of our open source metadata API, [stash-box](https://github.com/stashapp/stash-box).</sub>
Stash is available in 32 languages (so far!) and it could be in your language too. We use Weblate to coordinate community translations. If you want to help us translate Stash, you can make an account at [Codeberg's Weblate](https://translate.codeberg.org/projects/stash/stash/) to contribute to new or existing languages. Thanks!
82
-
83
-
The badge below shows the current translation status of Stash across all supported languages:
You can find an overview of Stash's architecture in the [ARCHITECTURE.md](docs/ARCHITECTURE.md) document.
110
106
111
-
## Backend
107
+
## Contributing
112
108
113
-
- Go
114
-
- GraphQL API
115
-
- SQLite
109
+
We welcome contributions and help from all humans who want to improve the project.
116
110
117
-
## Frontend
111
+
Before contributing, please read the [Contributing](docs/CONTRIBUTING.md) document to understand our guidelines and processes for contributing to the project.
118
112
119
-
- React
120
-
- TypeScript
113
+
You can learn about setting up a local development environment in the [Development](docs/DEVELOPMENT.md) document.
121
114
122
-
#For Developers
115
+
## Translation
123
116
124
-
Pull requests are welcome!
117
+
The widget below shows the current translation status of Stash across all supported languages. If you want to help us translate Stash, you can make an account at [Codeberg Translate](https://translate.codeberg.org/projects/stash/stash/) to contribute to new or existing languages. Thanks!
125
118
126
-
See [Development](docs/DEVELOPMENT.md) and [Contributing](docs/CONTRIBUTING.md) for information on working with the codebase, getting a local development setup, and contributing changes.
0 commit comments