Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Custom Support info #2054

Closed
proddy opened this issue Sep 26, 2024 · 3 comments
Closed

Feature: Custom Support info #2054

proddy opened this issue Sep 26, 2024 · 3 comments
Labels
enhancement New feature or request
Milestone

Comments

@proddy
Copy link
Contributor

proddy commented Sep 26, 2024

The current Help page shows

  • links to the wiki, discord and how to submit a request or report a bug in GitHub.
  • download links for support information and all values
  • a footer asking everyone to like the project in GitHub

The change

  1. For users that have a "guest" role, they don't have access to many of the Settings so this information above should only be shown for "admin" users.
  2. Allow for customized support information to be shown at the top of the Help page. You can upload a "support.json" file that contains some keys including "support_text" and "image_url" that are rendered in a 2-column table. This data is permanently stored in EMS-ESP and loaded at boot. If the file is not present, or badly formatted it will not be shown.
  3. Remove the footer. I think people know it's open-source.
@proddy proddy added the enhancement New feature or request label Sep 26, 2024
@proddy proddy added this to the v3.7.0 milestone Sep 26, 2024
@proddy
Copy link
Contributor Author

proddy commented Sep 26, 2024

1 in 3.7.0
2 to customize it via a JSON we'll add to 3.7.1

proddy added a commit to proddy/EMS-ESP32 that referenced this issue Sep 26, 2024
proddy added a commit to proddy/EMS-ESP32 that referenced this issue Sep 26, 2024
proddy added a commit that referenced this issue Sep 26, 2024
@proddy
Copy link
Contributor Author

proddy commented Sep 26, 2024

image

@proddy
Copy link
Contributor Author

proddy commented Sep 29, 2024

Add 2 and 3 to 3.7.0.

You can create a JSON file like:

{
  "type": "customSupport",
  "Support": {
  "html": [
    "This product is installed and managed by:",
    "",
    "<b>Bosch Installer Example</b>",
    "",
    "Nefit Road 12",
    "1234 AB Amsterdam",
    "Phone: +31 123 456 789",
    "email: [email protected]",
    "",
    "For help and questions please <a target='_blank' href='https://emsesp.org'>contact</a> your installer."
  ],
    "img_url": "https://emsesp.org/_media/images/designer.png"
  }
}

and upload it via the WebUI. It will be displayed in the Help page for both Admin and Guest users

@proddy proddy closed this as completed Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant