Sidebar Customization¶
Customize the Bambuddy sidebar by showing or hiding built-in pages, reordering navigation items, and adding custom links to external tools and resources.
:material-sidebar: Overview¶
Sidebar customization lets you:
- Keep your most-used Bambuddy pages near the top
- Hide built-in pages you do not use often
- Add one-click links to Spoolman, OctoPrint, Grafana, and other tools
- Set a default sidebar layout for other users
Built-in Pages¶
Built-in Bambuddy pages can be shown, hidden, and reordered from the sidebar settings.
- Go to Settings > General
- Open the Sidebar pane
- Toggle pages on or off
- Drag visible pages into your preferred order
Hidden pages are removed from the sidebar navigation. Use this to keep the sidebar focused on the pages you use day to day.
Hidden pages remain accessible by direct URL and from any in-app links that point to them. Settings cannot be hidden, so you can always return to the sidebar settings and show pages again.
External Links¶
External links add custom sidebar entries for tools and resources outside Bambuddy.
Adding a Link¶
- Go to Settings > External Links
- Click Add Link
- Fill in the details:
| Field | Description |
|---|---|
| Name | Display name (e.g., "Spoolman") |
| URL | Full URL including protocol |
| Icon | Select an icon |
| Open in New Tab | Open link in new tab |
- Click Save
Editing¶
- Click the edit icon on a link
- Modify any field
- Click Save
Deleting¶
- Click the delete icon
- Confirm deletion
Icons¶
Choose from Material Design icons:
| Icon | Name | Good For |
|---|---|---|
| :material-spool: | Spool | Spoolman, filament |
| Printer | OctoPrint, Mainsail | |
| Chart | Analytics, Grafana | |
| Cog | Settings, config | |
| GitHub | Repositories | |
| Document | Documentation | |
| Home | Dashboards | |
| Link | Generic links |
Additional icons available in the icon picker.
Ordering and Visibility¶
Reordering¶
Built-in pages and external links can be reordered together from the sidebar settings.
- Go to Settings > General
- Open the Sidebar pane
- Drag an item to a new position
- Release to save the new order
Visibility¶
Use sidebar visibility controls to decide what appears in navigation:
- Built-in pages can be shown or hidden from the sidebar settings
- Settings is always visible and cannot be hidden
- Hidden built-in pages stay available by direct URL and from in-app links
- External links cannot be hidden; delete an external link to remove it from the sidebar
External Link Appearance¶
External links display with:
- Icon (if selected)
- Name
- External indicator (if opens new tab)
Use Cases¶
Spoolman¶
Link to your filament inventory:
| Field | Value |
|---|---|
| Name | Spoolman |
| URL | http://192.168.1.50:7912 |
| Icon | :material-spool: |
| Sidebar | Yes |
| New Tab | Yes |
OctoPrint / Mainsail¶
Link to printer web interfaces:
| Field | Value |
|---|---|
| Name | Mainsail |
| URL | http://192.168.1.100 |
| Icon | |
| Sidebar | Yes |
| New Tab | Yes |
Grafana Dashboard¶
Link to monitoring dashboards:
| Field | Value |
|---|---|
| Name | Grafana |
| URL | http://grafana:3000/d/printers |
| Icon | |
| Sidebar | Yes |
| New Tab | Yes |
Documentation¶
Link to manuals or wikis:
| Field | Value |
|---|---|
| Name | Docs |
| URL | https://github.com/maziggy/bambuddy-wiki |
| Icon | |
| Sidebar | Yes |
| New Tab | Yes |
Printables / Thingiverse¶
Quick access to model sites:
| Field | Value |
|---|---|
| Name | Printables |
| URL | https://www.printables.com |
| Icon | |
| Sidebar | Yes |
| New Tab | Yes |
Admin Default Sidebar Order¶
Admins can set a default sidebar navigation layout that applies to users who have not customized their own sidebar. The default captures the saved order for built-in pages and external links, plus the visibility state for built-in pages.
Setting a Default¶
- Arrange sidebar items in your preferred order
- Show or hide the built-in pages you want included
- Go to Settings > General > Sidebar Order
- Toggle Set Default on
The current sidebar layout is saved as the default for all users.
How It Works¶
| Scenario | Behavior |
|---|---|
| New user | Automatically gets the admin-set sidebar layout |
| User hasn't customized | Gets the admin-set layout on next page load |
| User has customized | Keeps their own layout (admin default is not re-applied) |
| Admin toggles off | Default is cleared; existing user layouts are unchanged |
Permission Required
The Set Default toggle is only visible to users with Settings: Update permission (settings:update).
One-Time Application
The default layout is applied once per user. If you update the default, users who already received a previous default will not be affected. To re-apply it, users can click Reset on their sidebar order first.
Keyboard Shortcuts¶
Visible sidebar entries can be accessed via keyboard:
- Sidebar items are assigned number shortcuts
- Press the assigned number to navigate
Shortcut Assignment
Shortcut assignment follows the current sidebar layout. Reordering items or hiding built-in pages updates the number shortcuts automatically.
Backup Integration¶
Sidebar customization is included in backups:
- External links are exported with database backups
- Sidebar order and built-in page visibility settings are restored when importing a backup
- No manual re-entry needed after restore
Tips¶
Related Tools
Add links to tools you use alongside Bambuddy for quick switching.
Open in New Tab
Enable "New Tab" to keep Bambuddy open while visiting links.
Organize by Usage
Put most-used pages and links at the top via drag-and-drop.
Keep It Clean
Hide rarely-used pages and links from the sidebar to reduce clutter.