Kumu
  • Getting started
    • Welcome
    • Kumu 101
    • First steps
    • Quick tips
    • Webinars
  • Overview
    • Kumu's architecture
    • Accounts and workspaces
    • Kumu.io and Kumu Enterprise
    • Billing
    • User interfaces
      • Dashboard
      • Settings
      • Map editor
      • View editors
      • Quick Actions
    • Collaborating and sharing
    • Actions and permissions
    • Security
    • Advanced Editor hub
      • @settings reference
      • @controls reference
      • Color reference
      • Property reference
      • Selector reference
  • DISCIPLINES
    • SNA / Network Mapping
    • Systems mapping
    • Systems Practice workbook
  • Guides
    • Activity feed
    • Add-ons
      • Disqus
    • Bridge
    • Cluster
    • Controls
      • Cluster control
      • Color-legend control
      • Filter control
      • Focus control
      • Image control
      • Label control
      • Showcase control
      • SNA-dashboard control
      • Tagged-timeline control
      • Text Control
      • Title Control
      • View toggle control
    • Decorations
      • Direct decorations
      • Data-driven decorations
      • Flags
      • Icons
      • Images
      • Label templates
      • Popovers
    • Default view settings
    • Export
    • Fields
      • Computed fields
    • Filter
    • Focus
    • Forking
    • Grids & Guides
    • Import
      • Structure your data for Kumu
      • Excel / CSV
      • Google Sheets
      • JSON / Blueprints
    • Imported views
    • Layouts
      • Fixed
      • Force-directed
      • Remove overlap
      • Scatter
      • Snap-to
    • Legends
    • Licensing
    • Lightbox
    • Loops
    • Metrics
    • Two-factor authentication
    • Pro workspaces
      • Archiving projects
      • Discussions
    • Partial views
    • Presentations
    • Profiles
      • Markdown
    • Project admin
    • Selectors
    • Shapes
    • Share and embed maps
    • Shortcuts
    • Showcase
    • Slugs
    • Table
    • Templates
      • Geo template
    • URLs
    • Views
    • Widgets
  • About Kumu
    • What is Kumu?
    • How does it work?
    • Where can I get help?
  • Enterprise
    • About enterprise
    • Getting started with VMWare
    • Upgrading
    • Configuration
    • Creating user accounts
    • SSH Access
    • Single sign-on
    • Backing up enterprise data
    • Restoring enterprise data
    • Command line utilities
    • Changelog
  • Frequently Asked Questions
    • Does Kumu have a public API?
    • Does Kumu make use of AI?
    • How do I add annotations?
    • How do I add anchors to my map description?
    • How do I add arrows to my connections?
    • How do I add documents to profiles?
    • How do I add more than one element with the same label?
    • How do I add text dropdowns to my map overview?
    • How do I adjust arrow size?
    • How do I avoid duplicating data?
    • How do I change connection curvature?
    • How do I change font color?
    • How do I change font size?
    • How do I change the default for currency fields?
    • How do I change the length or strength of connections?
    • How do I change the order of control options?
    • How do I change the position of my element labels?
    • How do I cite Kumu?
    • How do I collapse duplicate connections?
    • How do I copy a map to another project?
    • How do I control label size while scaling element size?
    • How do I control text wrapping?
    • How do I convert a project from private to public?
    • How do I convert a project from public to private?
    • How do I create dynamic on/off toggles for my map?
    • How do I customize link text in popovers?
    • How do I customize the order of my legend?
    • How do I delete a project, map, or view?
    • How do I delete data from my project?
    • How do I downgrade my subscription?
    • How do I edit virtual elements?
    • How do I get rid of duplicates?
    • How do I hide elements without connections?
    • How do I hide images from the map but keep them in the profile?
    • How do I hide labels on my map?
    • How do I hide the settings button?
    • How do I keep elements from moving?
    • How do I list an element's connections in its profile?
    • How do I make elements transparent?
    • How do I make sense of my receipt?
    • How do I open a sub-system when clicking on an element?
    • How do I remove the Opposite entry from my legend?
    • How do I remove unneeded controls?
    • How do I remove unwanted legend entries?
    • How do I rename my map/view?
    • How do I restructure my adjacency matrix?
    • How do I select options by default in my control?
    • How do I set a minimum or maximum zoom level for my map?
    • How do I show the Settings button?
    • How do I size elements based on number of connections?
    • How do I transfer a project?
    • How do I update my credit card information?
    • How much data can my Kumu project handle?
    • How do my readers switch between maps and views?
    • My data won't import. What can I do?
    • My Kumu embed is not working. What can I do?
    • My map disappeared. How do I bring it back?
    • My PDF won't export. What can I do?
    • What pricing plans does Kumu have?
    • Where can I find my invoices?
    • Where can I find example Kumu projects?
Powered by GitBook
On this page
  • kumu-logs-dump
  • kumu-export
  • kumu-import
  • kumu-ssl-enable
  • kumu-ssl-disable
  • kumu-ssl-install-cert
  • kumu-ssl-install-key
  • kumu-ssl-enable-selfsigned

Was this helpful?

Edit on GitHub
  1. Enterprise

Command line utilities

PreviousRestoring enterprise dataNextChangelog

Last updated 2 years ago

Was this helpful?

Kumu Enterprise comes with a set of command line utilities to help administer your appliance.

SSH access is required to use the utilities, so make sure to if you haven't already done so.

kumu-logs-dump

Use this command to export the system logs so our enterprise team can diagnose the errors:

ssh admin@<hostname> -- "kumu-logs-dump" > kumu-logs.tar.gz

kumu-export

Export the appliance's data and settings.

ssh admin@<hostname> -- "kumu-export" > kumu-backup.tar.gz

kumu-import

Import an existing backup into a fresh appliance.

Make sure you have uploaded your license before running this command.

ssh admin@<hostname> -- "kumu-import" < kumu-backup.tar.gz

kumu-ssl-enable

Use kumu-ssl-enable to re-enable SSL after disabling, or apply changes after uploading a new certificate and key.

ssh admin@<hostname> -- kumu-ssl-enable

kumu-ssl-disable

NOTE: Kumu Enterprise sends HSTS headers when SSL is enabled. Users will have to clear these headers from their browsers' cache to access the site via HTTP if SSL is disabled.

ssh admin@<hostname> -- kumu-ssl-disable

kumu-ssl-install-cert

Use kumu-ssl-install-cert to upload a custom certificate.

  • certificate must include subdomains (eg *.kumuenterprise.example.com)

  • certificate must not include a passphrase

  • certificate must be encoded in PEM format

  • certificate must include the full chain if signed by a CA

ssh admin@<hostname> -- "kumu-ssl-install-cert" < fullchain.pem

NOTE: After you have uploaded your certificate and key, you must run kumu-ssl-enable to apply the changes.

kumu-ssl-install-key

Use kumu-ssl-install-key to upload a custom private key.

  • key must be encoded in PEM format

ssh admin@<hostname> -- "kumu-ssl-install-key" < privkey.pem

NOTE: After you have uploaded your certificate and key, you must run kumu-ssl-enable to apply the changes.

kumu-ssl-enable-selfsigned

The kumu-ssl-enable-selfsigned allows your instance to use a self-signed SSL certificate that is generated for you automatically when the instance first boots.

Note: we consider this a legacy feature. While we still support kumu-ssl-enable-selfsigned, we only recommend using it for debugging purposes, or temporary Enterprise trials. We no longer recommended using the self-signed certificate in production with end users, since modern browsers will show persistent, strong security warnings that end users will have to repeatedly bypass.

Have questions?

enable ssh access
Contact Support