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

Custom Branding #665

Merged
merged 16 commits into from
Oct 17, 2022
Merged

Custom Branding #665

merged 16 commits into from
Oct 17, 2022

Conversation

MatthiasReumann
Copy link
Collaborator

@MatthiasReumann MatthiasReumann commented Sep 12, 2022

Changes

  • Update Dockerfile
  • Add API Route /logo.svg and /manifest.json
  • Add branding.go which reads a branding.yaml file for the customization of titles, etc.
  • Update README.md

How it works

Mount branding folder. Specify the folder in config.yaml. The custom logo and favicon should be visible.

If a branding.yaml is provided at the same location as config.yaml, it will be used for titles, etc.

If the branding folder doesn't exist the default TUM-Live configuration is used.

Add copy of opptional branding folder for
- manifest.json
- favicon.ico
- logo.svg
Add Customization to README.md
Add branding-example folder
Custom branding for titles, etc.
Add branding.yaml to /branding-example
Update templates
Copied from config.go for config.yaml
Add branding.yaml information
Add branding to volumes
@MatthiasReumann MatthiasReumann linked an issue Sep 12, 2022 that may be closed by this pull request
5 tasks
Dockerfile Outdated
Comment on lines 6 to 9
# Copy branding (if exists)
COPY 'brandin[g]/manifest.json' /app/web/assets/
COPY 'brandin[g]/favicon.ico' /app/web/assets/
COPY 'brandin[g]/logo.svg' /app/web/assets/img/
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to mount these with a volume like the branding.yaml?
End users should not be required to build the app themselves imo.

Changes look great otherwise!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Will look into it!

@joschahenningsen joschahenningsen merged commit 3199521 into dev Oct 17, 2022
@joschahenningsen joschahenningsen deleted the enhancement/607-custom-branding branch October 17, 2022 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make Branding Customizable
2 participants