Installation and usage

Overview

1. Unpack the tarball.  (Get it here.)
2. Add the appropriate binaries into your $PATH.
3. Create a user ID and password in the hucksh database with hucksh_passwd.
   • You also have to agree to the EULA.
4. If you have a license key, install it with hucksh_server -lic license_filename.
   • If you do not install a license key, the server will refuse to start after 32 days.
5. Run the server.
6. In your web browser, visit (for example) http://localhost:18022.

Command line arguments

hucksh_passwd [-db path/to/hucksh.db] username

Create a user ID/password in the given hucksh database, or reset the password for an existing user ID.

You can use your regular username, or a different one.  You can create multiple IDs, although that’s pretty pointless — they’ll all run “as you”, after all.

The password is read from the terminal.

If you plan to let your browser remember the password anyway, you might as well pick a good one.  Especially if you run hucksh facing the public Internet.  (Which is not yet recommended.)

hucksh_server [-db path/to/hucksh.db] -lic path/to/license/key.txt

Install a license key in the database and exit

hucksh_server [-db path/to/hucksh.db]
[-root path/to/hucksh/root/directory]
[-notls | [-tls] -priv path/to/private/key.pem -pub path/to/public/key.pem]
[hostname-or-IP-address]
[port]

-db defaults to $HOME/.hucksh.db
-root defaults to $HOME/.hucksh
hostname-or-IP-address defaults to localhost
port defaults to 18022

If you give a hostname or IP address that’s not “localhost”, then you must either specify -notls, or use -priv/-pub to specify a public and private key.  Note that “127.0.0.1” does not count as “localhost”.

The server can do TLS or non-TLS.  In the common case where you’re talking to it via ssh port forwarding, TLS seemed redundant, so it’s optional.

If you’re running hucksh on a remote machine, and it’s listening on localhost:18022 (the default), and you want to access it via ssh port forwarding, then your local ssh command is going to look something like this

ssh -L 18022:localhost:18022 $dest_server

License key

Buy a key here.  You’ll get an email with something like this in it.

-----BEGIN LICENSE-----
Version: 1
Name: Your Name
Email: you@example.com
Product: hucksh
Key: a_long_string_of_hex_digits_ending_in_equals=
-----END LICENSE-----

Paste this into a text file, and run

hucksh_server -lic path/to/that/file.txt