9001 / 9001/copyparty

Product configuration wizard

Abierto
#57 13 comentarios 0 reacciones 1 asignado Reclamado por @9001 Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
46.6k
Forks
1.9k
Merge medio
10 d 16 h
PR fusionados (30 d)
5

Descripción

**is your feature request related to a problem? Please describe.**
The product has so many configuration parameters with a lot of cross-dependencies between them already and new options keep coming with new releases. It would be not so easy task for a new user to go through all of them to configure a new product instance correctly according to the environment and business needs. Later, if the admin doesn't read each new release note, it would be difficult to stay on the same page and keep the product config in an optimal state.

**Describe the idea / solution you'd like**
I propose to implement some stand-alone script, which would represent an installation and migration wizard with the next flow:
- in case of fresh deployment it should guide a user through all the configuration options subsequently (respecting dependencies) with a detailed and clear description of each option, its impact, use cases, and examples. There might be a lot of steps, so some progress indication, intermediate save, and ability to stop and later get back to the same point is needed.
- in case of an upgrade from a previous version (in-place), it should get the previous config and guide a user through the delta between the versions: pretty the same, but with much fewer steps, and if something previously available was changed, it should be clearly indicated.
- in case of a migration to another system (side-by-side), I'm not sure what is better: from 1 side asking a user to go through all the steps, as for fresh installation while a significant part of options from the source deployment might be the same looks like wasting time, but from another side, we couldn't be sure which options should be changed and which - not: answer to this question is from user's business area, not from technical one. However, I'm not an expert in the Copyparty, so I might not see the whole picture.
After the wizard completion, there should be a config for Copyparty with all user answers reflected and a step-by-step guide on how to deploy the product and apply the config (all supported setups should be taken into account as part of the wizard)

**Describe any alternatives you've considered**
Keep it "as is" and force a user to manually configure the product putting all the responsibility of misconfiguration on the user's side

**Additional context**
This request came from my personal experience of analyzing a long list of config params with not-so-clear (as to me) descriptions, and I believe that my setup is not optimal (it is running in a local network behind a firewall, so it isn't so critical, but still...)
Feel free to ask some questions in comments in case you need to clarify something)

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.