SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-03-31 06:34:19 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

[Feature Request] Option to export different kinds of configurations #2244

New Issue
Open
opened 2025-11-20 07:06:26 -05:00 by saavagebueno · 1 comment
saavagebueno commented 2025-11-20 07:06:26 -05:00
Owner
Copy Link

Originally created by @chirag-rastogi on GitHub (Sep 3, 2025).

Summary
I'd like to request a new feature for the NetBird dashboard that allows administrators to export various configuration data. Currently, there's no way to download or back up information like the list of users, peers, or setup keys. This feature would be essential for auditing, migration, and disaster recovery.

Motivation
As a NetBird administrator, being able to export key configurations is crucial for several reasons:

Auditing and Reporting: Having a downloadable list of all users, peers, and their associated data would make it much easier to perform regular security audits and generate reports for compliance purposes.

Migration: If we ever need to move our NetBird setup to a new server or platform, exporting the configurations would streamline the process and ensure no data is lost.

Disaster Recovery: In the event of a system failure, having a recent backup of our configurations would be invaluable for quickly restoring the network to a functional state.

Offline Analysis: The ability to export data as a CSV or JSON file would allow for more detailed offline analysis and integration with other tools.

Proposed Functionality
I propose adding an "Export" button to the following sections of the NetBird dashboard:

Users:

Export Data: A button to export a list of all users.

Export Format: This should be available in common formats like CSV and JSON.

Data to Include: User ID, email, roles, and status.

Peers:

Export Data: A button to export a list of all connected peers.

Export Format: Available in CSV and JSON.

Data to Include: Peer ID, name, IP address, OS, and last seen timestamp.

Setup Keys:

Export Data: A button to export a list of all setup keys.

Export Format: Available in CSV and JSON.

Data to Include: Key name, expiration date, and usage count.

Additional Considerations
Permissions: The export functionality should be restricted to users with administrator or similar high-level privileges.

API Support: Alongside the UI feature, it would be beneficial to have a corresponding API endpoint for each export type, allowing for automated backups and integration with scripts.

Data Security: The exported files should be handled with care, and the system should provide a clear warning about the sensitive nature of the data.

This feature would significantly improve the usability and manageability of NetBird for administrators, making it a more robust solution for enterprise environments. Thank you for considering this request.

Originally created by @chirag-rastogi on GitHub (Sep 3, 2025). Summary I'd like to request a new feature for the NetBird dashboard that allows administrators to export various configuration data. Currently, there's no way to download or back up information like the list of users, peers, or setup keys. This feature would be essential for auditing, migration, and disaster recovery. Motivation As a NetBird administrator, being able to export key configurations is crucial for several reasons: Auditing and Reporting: Having a downloadable list of all users, peers, and their associated data would make it much easier to perform regular security audits and generate reports for compliance purposes. Migration: If we ever need to move our NetBird setup to a new server or platform, exporting the configurations would streamline the process and ensure no data is lost. Disaster Recovery: In the event of a system failure, having a recent backup of our configurations would be invaluable for quickly restoring the network to a functional state. Offline Analysis: The ability to export data as a CSV or JSON file would allow for more detailed offline analysis and integration with other tools. Proposed Functionality I propose adding an "Export" button to the following sections of the NetBird dashboard: Users: Export Data: A button to export a list of all users. Export Format: This should be available in common formats like CSV and JSON. Data to Include: User ID, email, roles, and status. Peers: Export Data: A button to export a list of all connected peers. Export Format: Available in CSV and JSON. Data to Include: Peer ID, name, IP address, OS, and last seen timestamp. Setup Keys: Export Data: A button to export a list of all setup keys. Export Format: Available in CSV and JSON. Data to Include: Key name, expiration date, and usage count. Additional Considerations Permissions: The export functionality should be restricted to users with administrator or similar high-level privileges. API Support: Alongside the UI feature, it would be beneficial to have a corresponding API endpoint for each export type, allowing for automated backups and integration with scripts. Data Security: The exported files should be handled with care, and the system should provide a clear warning about the sensitive nature of the data. This feature would significantly improve the usability and manageability of NetBird for administrators, making it a more robust solution for enterprise environments. Thank you for considering this request.
saavagebueno added the feature-request label 2025-11-20 07:06:26 -05:00
saavagebueno commented 2025-11-20 07:06:27 -05:00
Author
Owner
Copy Link

@scroguard commented on GitHub (Sep 22, 2025):

this is a great request. i would even go as far as to say that building in a full backup system within netbird that could export the entire system would be very useful.

@scroguard commented on GitHub (Sep 22, 2025): this is a great request. i would even go as far as to say that building in a full backup system within netbird that could export the entire system would be very useful.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label feature-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#2244
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?