---
name: "sshproxy-setup"
section: "8"
platform: "linux"
package: "sshproxy"
version: "0.6.0~beta2-2"
release: "Debian 5.0 (Lenny)"
platforms: ["linux"]
url: "https://new.carta.tech/sshproxy-setup"
---

# sshproxy-setup(8)

sshproxy configurator

## NAME

sshproxy-setup - sshproxy configurator

## SYNOPSIS

**sshproxy-setup \[--config-dir *cfgdir*\] \[--user *user*\]**\
     Display a menu to edit configuration.

**sshproxy-setup \[--config-dir *cfgdir*\] \[--user *user*\] --add-admin *admin***\
     Add an administrator to [*sshproxyd*(8)](/sshproxyd/8.md) database.

**sshproxy-setup \[--config-dir *cfgdir*\] \[--user *user*\] --cipher *cipher* \[--keep\] \[--dry-run\]**\
     Recipher the site database with a new cipher.

## DESCRIPTION

*sshproxy-setup* is a front-end to configure the *sshproxyd* daemon.

If no other *options* than --config-dir and --user are given, *sshproxy-setup* will show a menu allowing the administrator to edit the sshproxy.ini main configuration file.

## OPTIONS

- **--version**

  Show program's version number and exit.

- **--help (-h)**

  Display a short help message.

- **--config-dir (-c)**

  Specify a configuration directory where lies the main configuration file *sshproxy.ini* and the private DSA private key *id\_dsa*. Default value is *~/.sshproxy*.

- **--user (-u)**

  Give configuration files ownership to *user*. This option is mandatory if [*sshproxyd*(8)](/sshproxyd/8.md) is run as root.

- **--add-admin**

  Add a new admin in the database. This works by first adding a new user in the client database, then it adds a few ACL rules in the ACL database for the new *admin* to be able to connect to the [*sshproxyd*(8)](/sshproxyd/8.md) console with **unlimited** rights. This is not the way to add users!

- **--cipher**

  Recipher the site database with a new cipher engine. Reciphering from blowfish to blowfish is not supported, so you may want to recipher to base64 first, then to blowfish. The *cipher* engine can be one of **plain**, **base64** or **blowfish**.

**--keep (-k) (applies to --cipher only)**

When reciphering to blowfish, don't ask for a passphrase but use the one already present in [*sshproxy.ini*(5)](/sshproxy.ini/5.md).

**--dry-run (-n) (applies to --cipher only)**

When reciphering, don't do anything but displays passwords (old cipher / plain / new cipher). Useful when developping a new cipher engine.

## FILES

*~/.sshproxy/sshproxy.ini*

The main configuration file. See *sshproxy.ini* for further details.

## ENVIRONMENT

- SSHPROXY\_CONFIG

  If non-null the full path to the configuration directory. Equivalent to the **-c** option.

- INITD\_STARTUP

  The command to restart the proxy. *sshproxy-setup* will display this command at exit to recall the administrator how to restart *[sshproxyd(8)](/sshproxyd/8.md).* *Mainly useful when running sshproxy-setup in the postinstall hook of a* *distribution package.*

## BUGS

*None known.*

*You can report any bug found on the sshproxy mailing list:*

*sshproxy@penguin.fr*

## AUTHOR

*David Guerizec \<david@guerizec.net\>*

## SEE ALSO

[**sshproxyd**(8)](/sshproxyd/8.md), [**sshproxy.ini**(5)](/sshproxy.ini/5.md), **pssh**(1), [**pscp**(1)](/pscp/1.md),

*The sshproxy home page: \<http://sshproxy-project.org/*\>

The sshproxy online documentation:

\<*http://sshproxy-project.org/documentation/*\>