documentation/.github/ISSUE_TEMPLATE/new_instance.yaml
Émilien (perso) c1d870cb15
Add part for matrix username (#556)
* Add part for matrix username

* Fix broken english + better wording

---------

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com>
2024-05-15 13:36:05 +02:00

105 lines
3.7 KiB
YAML

name: New instance
description: New public instance proposal form
title: "[New instance] <instance name>"
assignees:
- unixfox
- samantazfox
labels:
- instance-add
body:
- type: markdown
attributes:
value: |
Please consult these two important tutorials:
- Escaping the YouTube block ([403 errors in playback](https://github.com/iv-org/invidious/issues/4045)): https://docs.invidious.io/ipv6-rotator/
- Improving the performance and the stability of your public instance: https://docs.invidious.io/improve-public-instance/
It is highly recommended to follow these tutorials because it will allow the instance to stay stable and performant over the long term.
- type: input
id: url
attributes:
label: URL
description: "the URL of your instance"
placeholder: "Example: https://invidious.example.com"
validations:
required: true
- type: checkboxes
attributes:
label: Mandatory checks
description: "Your instance must fulfill all the conditions listed below in order to be accepted"
options:
- label: "Instance has a domain name"
required: true
- label: "Instance is served over HTTPS"
required: true
- label: "Statistics (`/api/v1/stats`) are enabled"
required: true
- label: "Instance is properly configured (including the mandatory [post install configuration](https://docs.invidious.io/installation/#post-install-configuration))"
required: true
- label: "Instance has an automatic hourly restart setup of Invidious"
required: true
- label: "If dash, proxy + download is enabled (default settings), the instance has unlimited traffic/bandwidth or close to unlimited (100TB minimum)"
required: true
- label: "Instance is not running any kind of analytics"
required: true
- type: checkboxes
attributes:
label: Maintainer chart
description: "As a maintainer, I acknowledge that I must do the following to stay in the public list"
options:
- label: "Ensure that my instance is up to date (less than one month old)"
required: true
- label: "Ensure a proper uptime of my instance (around 90%)"
required: true
- type: input
id: country
attributes:
label: Host country
description: What country is the instance hosted in?
placeholder: "Example: United States"
validations:
required: true
- type: input
id: mitm-name
attributes:
label: Man in the Middle
description: "If your instance is behind a DDoS protection or MitM system, please specify that here"
placeholder: "Example: CloudFlare"
validations:
required: false
- type: input
id: source-code-url
attributes:
label: Source code URL
description: "If your instance is running a modified source code, please provide the URL below"
placeholder: "Example: https://git.example.com/you/invidious"
validations:
required: false
- type: input
id: matrix-username
attributes:
label: Your matrix username
description: "Please input your Matrix username here to join the private Matrix room for public instances maintainers. We discuss troubles managing a public instance, share some advices and more. Optional but highly recommended."
placeholder: "matrixuser"
validations:
required: false
- type: textarea
id: more-infos
attributes:
label: Additional information
description: "If you want to add other information on your instance, do so here:"
placeholder: "Example: Our instance also has an .onion URL, The source code changes are ..., etc."
validations:
required: false