documentation/.github/ISSUE_TEMPLATE/new_instance.yaml

103 lines
3.5 KiB
YAML
Raw Normal View History

name: New instance
description: New public instance proposal form
title: "[New instance] <instance name>"
2021-09-13 20:40:08 +00:00
assignees:
- unixfox
- samantazfox
labels:
- instance-add
body:
2023-02-17 11:01:59 +00:00
- type: markdown
attributes:
value: |
Please consider joining our Matrix room for public instance maintainers by joining our Matrix room: https://matrix.to/#/#invidious:matrix.org
then pinging @unixfox, @TheFrenchGhosty and @SamantazFox for asking to be invited to the Matrix room.
We discuss troubles managing a public instance, sharing some advices and more.
2021-09-13 20:47:25 +00:00
- type: input
id: url
attributes:
label: URL
description: "the URL of your instance"
placeholder: "Example: https://invidious.example.com"
validations:
required: true
2021-09-13 20:38:11 +00:00
- 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
2022-08-21 13:15:48 +00:00
- 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
2021-09-13 20:38:11 +00:00
- 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
2021-09-13 20:38:11 +00:00
- 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"
2021-09-13 20:38:11 +00:00
placeholder: "Example: CloudFlare"
validations:
required: false
2021-09-13 20:38:11 +00:00
- 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
2021-09-13 20:38:11 +00:00
- type: checkboxes
attributes:
label: Analytics
description: "If your instance is running analytics:"
options:
- label: "They are GDPR/CCPA compliant"
required: false
- label: "This is stated in your Privacy Policy"
required: false
- label: "You have provided the source code's URL in the dedicated field above"
required: false
- type: textarea
id: more-infos
attributes:
2022-07-01 18:28:31 +00:00
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