---
title: "Charmhub | Deploy Local Users\n using Charmhub - The Open Operator Collection"
description: "Deploy the latest version of Local Users\n on any cloud."
url: https://charmhub.io/local-users/configurations
---

# Local Users

[Canonical BootStack Charmers](https://charmhub.io/publisher/bootstack-charmers "View all packages from Canonical BootStack Charmers")

* [Canonical BootStack Charmers](https://charmhub.io/publisher/bootstack-charmers "View all packages from Canonical BootStack Charmers")

Platform:

24.04

22.04

20.04

18.04

stable 216

```
juju deploy local-users
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [allow-existing-users](https://charmhub.io/local-users/configurations#allow-existing-users)
* [backup-path](https://charmhub.io/local-users/configurations#backup-path)
* [group](https://charmhub.io/local-users/configurations#group)
* [ssh-authorized-keys](https://charmhub.io/local-users/configurations#ssh-authorized-keys)
* [sudoers](https://charmhub.io/local-users/configurations#sudoers)
* [users](https://charmhub.io/local-users/configurations#users)

[Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration)

* allow-existing-users | boolean

  When set to False the charm will enter 'blocked' state when user exists in 'users' config and in the system, but not in the charm managed group. Setting to True disables that protection and allows for pre-existing users to be added to the charm managed group.
* backup-path | string

  Default: /var/lib/misc/charm-local-users/backup

  Location on the unit that will be used for storing backups of home directories of removed users.
* group | string

  Default: charm-managed

  Group name for users managed by the charm.
* ssh-authorized-keys | string

  Default: $HOME/.ssh/authorized\_keys

  The file to write the SSH public keys to.
  This option supports the usage of variables "$USER", "$HOME" and "$UID" in the path string.
  They will be expanded to the username, home directory and the user id of each user.
* sudoers | string

  Custom /etc/sudoers.d file. File name is 70-local-users-charm
  Visudo is used to check for syntax errors and print them in the charm status and more verbose in juju debug logs.

  Example:
  Cmnd\_Alias ALLOWED\_CMDS = /usr/sbin/dmidecode,
  /usr/sbin/hwinfo,
  /sbin/ifconfig,
  /bin/ps

  myuser ALL = (ALL) NOPASSWD: ALLOWED\_CMDS
* users | string

  List of (username; Gecos Name; SSH pub key) tuples.
  Fields must be separated by semicolons ';'.
  Multiple ssh keys can be provided per user by adding multiple lines
  with the same username and gecos.
  SSH keys can also be retrieved from launchpad by using the launchpad
  username prepended with 'lp:'

  Example:
  alice;Alice;<ssh\_pub\_key>
  bob;Bob;<ssh\_pub\_key>
  alice;Alice;lp:alice
  bob;Bob;lp:bob
  monitoring;Remote Monitoring;<ssh\_pub\_key1>
  monitoring;Remote Monitoring;<ssh\_pub\_key2>
  monitoring;Remote Monitoring;<ssh\_pub\_key3>