stashapp/Stash-Docs
1
0
Fork 0
mirror of https://github.com/stashapp/Stash-Docs.git synced 2025-12-10 17:32:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add Matrix page

Browse Source 
Updated Home page
Update footer
This commit is contained in:
DogmaDragon 2023-05-01 06:15:28 +03:00
parent e1ad031bb1
commit 0ff66fc26b
4 changed files with 160 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_config.yml
View File

@ -31,6 +31,10 @@ nav_external_links:
# Footer content
# appears at the bottom of every page's main content
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub"
@ -38,10 +42,6 @@ gh_edit_repository: "https://github.com/stashapp/Stash-Docs" # the github URL fo
gh_edit_branch: "main" # the branch that your docs is served from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
search_enabled: true
search:

2
_includes/footer_custom.html
View File

@ -1 +1 @@
<p class="text-small text-grey-dk-100 mb-0">Maintained by Stash community</p>
<p class="text-small text-grey-dk-100 mb-0">Maintained by Stash community and lincensed under AGPL-3.0</p>

33
home.md
View File

@ -5,15 +5,34 @@ nav_order: 1
permalink: /
---
# What is Stash?
# Stash
[Stash](https://stashapp.cc){:target="_blank"} is a web front-end app for serving and organizing your porn collection. Stash currently supports Windows, Linux, and macOS. To download Stash see the [latest releases](https://github.com/stashapp/stash/releases){:target="_blank"}. You can learn more about the software generally via the [README](https://github.com/stashapp/stash/blob/master/README.md){:target="_blank"} on the official repository or find answers to [Frequently Asked Questions (FAQ)](/faq) here.
[![Weblate project translated](https://img.shields.io/weblate/progress/stash?server=https%3A%2F%2Ftranslate.stashapp.cc&logo=weblate&style=for-the-badge)](https://translate.stashapp.cc/engage/stash/){:target="_blank"}
[![Open Collective backers](https://img.shields.io/opencollective/backers/stashapp?logo=opencollective&style=for-the-badge)](https://opencollective.com/stashapp){:target="_blank"}
[![Matrix](https://img.shields.io/matrix/stashapp:unredacted.org?logo=matrix&server_fqdn=matrix.org&style=for-the-badge)](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"}
[![Discord](https://img.shields.io/discord/559159668438728723.svg?logo=discord&style=for-the-badge)](https://discord.gg/2TsNFKt){:target="_blank"}
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/stashapp/stash?logo=github&style=for-the-badge)](https://github.com/stashapp/stash/releases/latest){:target="_blank"}
# Stash in Action
[Stash](https://stashapp.cc){:target="_blank"} is a web application written in Go for serving and organizing your porn collection. It is self-hosted and released under AGPL-3.0 license. Stash currently supports Windows, Linux, macOS and Docker.
Safe for work demo video of how Stash looks and what functionality it has.
# Start Using Stash
{: .note }
Video is a bit outdated and more functionality was added since it was created.
To get started go to [Getting Started](/getting-started) and grab the latest version for your operating system. You can learn more about the software generally via the [README](https://github.com/stashapp/stash/blob/master/README.md){:target="_blank"} on the official repository or via [official website](https://stashapp.cc){:target="_blank"}.
[![Stash 0.5.0 SFW demo (2021-02-23)](/assets/home/video.png)](https://player.vimeo.com/video/545323354 "Stash 0.5.0 SFW demo (2021-02-23)"){:target="_blank"}
# Support
- Find answers to most [Frequently Asked Questions (FAQ)](/faq)
- Join our [Matrix space](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"}
- Join our [Discord server](https://discord.gg/2TsNFKt){:target="_blank"}
- Start a [discussion on GitHub](https://github.com/stashapp/stash/discussions){:target="_blank"}
# Contribute
- **Spread the word**: the more people that know about Stash, the more people can help with the tasks below.
- **Help other users:** we got new users coming in all the time that need assistance. Stopping in help channels/rooms now and again to assist can save developers some time.
- **Write documentation**: help to improve the Stash documentation.
- **Contribute to the website**: the website could definitely use some attention.
- **Finds bugs**: test the software for bugs and create GitHub issues for them to help developers confirm and fix them faster.
- **Write scrapers**: if there is a site that isn't being scraped properly or at all, head on over to scrapers channel/room and see if you can't help scrape some metadata from a site.
- **Populate StashDB**: StashDB is our canonical database where we store metadata and hashes. You can submit info from your Stash instance to the database or just help tyo improve the already existing information.
- **Support financially**: Stash development runs on donations. Donations are collected through OpenCollective. You can do anonymous donations, recurring donations, or even contribute towards a specific feature, incentivizing that bit to get done potentially faster.

129
matrix.md Normal file
View File

@ -0,0 +1,129 @@
---
layout: clean
title: Matrix
description: Matrix details on Stash space and rooms
nav_order: 10
---
<details markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
# What is Matrix?
Matrix is an open-source internet protocol for secure, decentralised, real-time communication. Unlike other popular platforms like Discord, Matrix is federated. It consists of many servers, each server hosts Matrix accounts and chats. You can create an account on any Matrix server and the join other servers without having to re-create your account. One common example of federated protocol everyone uses today is email.
On Matrix, usernames are referred to as MXIDs (Matrix IDs), chats as rooms, servers as homeservers. Think of homeserver as the domain that hosts the instance. You can also group rooms together to form spaces (similar to Discord server).
In comparison to Discord:<br />
Username = Matrix ID<br />
Channel = Room<br />
Server = Space<sup>1</sup>
<sup>1</sup> Spaces are a collection of individual rooms.
# Registration on Matrix
There is no central place to register on. You can create an account on any homeserver and join spaces and rooms across all of them.
## Popular homeservers
- [matrix.org (click to create an account)<sup>2</sup>](https://app.element.io/#/register){:target="_blank"}
- [nitro.chat (click to create an account)](https://app.nitro.chat/#/register){:target="_blank"}
- [matrix.im (click to create an account)](https://element.matrix.im/#/register){:target="_blank"}
- [List of other public homeservers on joinmatrix.org](https://joinmatrix.org/servers/){:target="_blank"}
<sup>2</sup> Redirects to element.io domain, which is affiliated with matrix.org.
## Clients
{: .note}
Web-based clients are great to start and register. Element (web) is feature-rich and easy to use client.
Matrix supports a variety of clients on web, desktop (Windows, Linux, and macOS), and mobile (Android, iOS). matrix.org maintains a list of clients on their website [here](https://matrix.org/clients/){:target="_blank"}.
# Stash space
{: .important }
Rooms can be joined from inside the space. You can join one, or more rooms, or all rooms from the space. They are not directly tied to each other.
Our official space is located at [#stashapp:unredacted.org](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"}.
# Stash rooms
{: .important }
We are using a bridge bot that relays Discord and Matrix messages both ways in some rooms. They will be marked (bridged). Some features doesn't translate through the bridge like reactions and threads.
## Stash-focused rooms
- [#stash-announcements:unredacted.org](https://matrix.to/#/#stash-announcements:unredacted.org){:target="_blank"} (bridged) - Stash software updates
- [#stash-help:unredacted.org](https://matrix.to/#/#stash-help:unredacted.org){:target="_blank"} (bridged) - Help with anything related to Stash software
- [#stash-general:unredacted.org](https://matrix.to/#/#stash-general:unredacted.org){:target="_blank"} (bridged) - Discussions loosely connected to Stash software
- [#stash-bugs:unredacted.org](https://matrix.to/#/#stash-bugs:unredacted.org){:target="_blank"} (bridged) - Reporting bugs about Stash software
- [#stash-requests:unredacted.org](https://matrix.to/#/#stash-requests:unredacted.org){:target="_blank"} (bridged) - Requesting features for Stash software
- [#stash-community-meta:unredacted.org](https://matrix.to/#/#stash-community-meta:unredacted.org){:target="_blank"} (bridged) - Discussions about exsiting issues related to stash software
- [#stash-data-hoarding:unredacted.org](https://matrix.to/#/#stash-data-hoarding:unredacted.org){:target="_blank"} (bridged) - Discussions about data hoarding
- [#stash-off-topic:unredacted.org](https://matrix.to/#/#stash-off-topic:unredacted.org){:target="_blank"} (bridged) - Discussions outside of general Stash software focus
- [#stash-discord-free-zone:unredacted.org](https://matrix.to/#/#stash-discord-free-zone:unredacted.org){:target="_blank"} - Dicsussions outside of Discord sphere
- [#stash-github-feed:unredacted.org](https://matrix.to/#/#stash-discord-free-zone:unredacted.org){:target="_blank"} - GitHub feed from various stashapp repositories
## StashDB-focused rooms
- [#stashdb-invites:unredacted.org](https://matrix.to/#/#stashdb-invites:unredacted.org){:target="_blank"} (bridged) - Place to get an invite to StashDB
- [#stashdb-guidelines:unredacted.org](https://matrix.to/#/#stashdb-guidelines:unredacted.org){:target="_blank"} (bridged) - Discussons about StashDB guidelines and proposals
- [#stashdb-general:unredacted.org](https://matrix.to/#/#stashdb-general:unredacted.org){:target="_blank"} (bridged) - Discussions loosely connected to StashDB site
- [#stashdb-ministry-of-truth:unredacted.org](https://matrix.to/#/#stashdb-ministry-of-truth:unredacted.org){:target="_blank"} (bridged) - Discussions about StashDB submissions and best practices
## NSFW explicit rooms
- [#stash-general-nsfw:unredacted.org](https://matrix.to/#/#stash-general-nsfw:unredacted.org){:target="_blank"} (bridged) - Discussions about anything related to NSFW
- [#stash-favorites-nsfw:unredacted.org](https://matrix.to/#/#stash-favorites-nsfw:unredacted.org){:target="_blank"} (bridged) - Showcase your favorites
- [#stash-x-ray:unredacted.org](https://matrix.to/#/#stash-x-ray:unredacted.org){:target="_blank"} (bridged) - Scene or performer identification
- [#stash-performer-facial-recognition:unredacted.org](https://matrix.to/#/#stash-performer-facial-recognition:unredacted.org){:target="_blank"} (bridged) - Facial recognition based tagginer of performers in scenes
- [#stash-ai-tagging:unredacted.org](https://matrix.to/#/#stash-ai-tagging:unredacted.org){:target="_blank"} (bridged) - AI in metadata tagging
- [#stash-feed-the-machine:unredacted.org](https://matrix.to/#/#stash-feed-the-machine:unredacted.org){:target="_blank"} (bridged) - Discussions loosely connected to AI
## Contributor-focused rooms
- [#stash-project-management:unredacted.org](https://matrix.to/#/#stash-project-management:unredacted.org){:target="_blank"} (bridged)
- [#stash-liguistics:unredacted.org](https://matrix.to/#/#stash-liguistics:unredacted.org){:target="_blank"} (bridged)
- [#stash-documentation:unredacted.org](https://matrix.to/#/#stash-documentation:unredacted.org){:target="_blank"} (bridged)
- [#stash-community-liaison:unredacted.org](https://matrix.to/#/#stash-community-liaison:unredacted.org){:target="_blank"} (bridged)
- [#stash-ui-ux:unredacted.org](https://matrix.to/#/#stash-ui-ux:unredacted.org){:target="_blank"} (bridged)
## Developer-focused rooms
- [#stash-stash-box:unredacted.org](https://matrix.to/#/#stash-stash-box:unredacted.org){:target="_blank"} (bridged) - Discussions related to stash-box API
- [#stash-programming:unredacted.org](https://matrix.to/#/#stash-programming:unredacted.org){:target="_blank"} (bridged) - Discussions loosely related to Stash programming
- [#stash-code-review:unredacted.org](https://matrix.to/#/#stash-code-review:unredacted.org){:target="_blank"} (bridged) - Code Validation and Testing for Windows, Mac and Linux PR's
- [#stash-sustainability:unredacted.org](https://matrix.to/#/#stash-sustainability:unredacted.org){:target="_blank"} (bridged) - Discussion about the sustainability of the Stash ecosystem
- [#stash-scrapers:unredacted.org](https://matrix.to/#/#stash-scrapers:unredacted.org){:target="_blank"} (bridged) - Metadata scraping, curation and automation techniques
- [#stash-plugins-and-scripts:unredacted.org](https://matrix.to/#/#stash-plugins-and-scripts:unredacted.org){:target="_blank"} (bridged) - Discussions loosely related to Stash add-ons
- [#stash-website:unredacted.org](https://matrix.to/#/#stash-website:unredacted.org){:target="_blank"} (bridged) - Disucssions about Stash website
- [#stash-rfc-discussion:unredacted.org](https://matrix.to/#/#stash-rfc-discussion:unredacted.org){:target="_blank"} (bridged) - Request for comments on interesting ideas
## Different stash-box rooms
- [#stash-pmvbox:unredacted.org](https://matrix.to/#/#stash-pmvbox:unredacted.org){:target="_blank"} (bridged) - discussions related to PMV Stash
- [#stash-fansdb:unredacted.org](https://matrix.to/#/#stash-fansdb:unredacted.org){:target="_blank"} (bridged) - discussions related to FansDB
# Tips and Tricks
- You can change your Display Name by going into Settings.
- If you use different Matrix ID than Discord username, you can set a custom ping for your old username (Settings > Notifications > Keyword).
- You can use web client to quickly create an account and then move to desktop based client for better experience.
# Further read on Matrix
- [joinmatrix.org guide](https://joinmatrix.org/guide/){:target="_blank"}
- [matrix.org FAQ](https://matrix.org/faq/){:target="_blank"}
- [kde.org guide](https://community.kde.org/Matrix){:target="_blank"}
- [calcuode.com guide](https://calcuode.com/matrix/){:target="_blank"}
- [Using Element Web](https://calcuode.com/matrix/element-web.html){:target="_blank"}
- [Using Element on Android](https://calcuode.com/matrix/element-android.html){:target="_blank"}
- [Using Element on iOS](https://calcuode.com/matrix/element-ios.html){:target="_blank"}