Skip to content

[FR] settings setup guide / OOBE #2284

Open

Description

@matmair

Problem
New installs can be configured a bunch - some stuff (like base url, name etc.) should really be set.

Suggested solution

  • A setup modal if it is the first run
  • Multipage wizard that guides through the experience
  • Mixin that enables plugins to show setup page
  • API endpoint to check if setups ran -> could be important for 3rd party systems
  • Maybe a role for users/admins to specify who gets shown setup screens

Describe alternatives you've considered
Make a whole setup guide in the docs - I do not think that would be as effective.

Examples of other systems
OctoPrint has a great setup workflow

Do you want to develop this?
The structure yes, I would like to discuss the details of what to show in the core contributer group

Activity

  1. added this to the 0.7.0 milestone on Nov 10, 2021
  2. modified the milestones: 0.7.0, 0.8.0 on Apr 30, 2022
  3. matmair commented on Apr 30, 2022

    @matmair
    MemberAuthor

    This is a vast one - deferring to later.

    @SchrodingersGat @eeintech I think our Out of Box Experience (OOBE) for new settings and plugins (with settings) needs some improvement. This will take some time but should tackle it if we get more users to reduce the starting friction and support load.

  4. changed the title [-][FR] settings setup guide[/-] [+][FR] settings setup guide / OOBE[/+] on Apr 30, 2022
  5. SchrodingersGat commented on Apr 30, 2022

    @SchrodingersGat
    Member

    Great idea @matmair - I am seeing this as a separate feature to the FTUE FR?

  6. matmair commented on May 1, 2022

    @matmair
    MemberAuthor

    Great idea @matmair - I am seeing this as a separate feature to the FTUE FR?

    @SchrodingersGat yes. I would see this to be much more important than #2907 and also as an architectural base to build up on for that.

  7. self-assigned this
    on May 7, 2022
  8. 5 remaining items

  9. modified the milestones: 0.10.0, 1.0.0 on Jan 4, 2023
  10. modified the milestones: 1.0.0, horizon on Jun 7, 2023
  11. modified the milestones: horizon, 1.2.0 on Oct 29, 2025
  12. matmair commented on Oct 29, 2025

    @matmair
    MemberAuthor

    See #10715, that does most of the checklist items

  13. modified the milestones: 1.2.0, 2.0.0 on Jan 13, 2026
  14. modified the milestones: 2.0.0, 1.7.0 on Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

User InterfaceRelated to the frontend / User InterfaceapiRelates to the APIenhancementThis is an suggested enhancement or new featurepluginPlugin ecosystem

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions