Skip to content

This repo has UI designs for the Mole project, a cli SSH tunnel manager application.

License

Notifications You must be signed in to change notification settings

ei8fdb/mole-design

Repository files navigation

What is this repo?

This repo has UI designs for the Mole project, from David Pinheiro and others.

What is Mole?

Mole is:

"a cli application to create ssh tunnels, forwarding a local port to a remote endpoint through a ssh server."

You can find documentation on how it works.

I'm interested in the project as a nice way to configure SSH tunnels on my Linux machine.

Also, I'd like to do some design work. :)

Designs

These designs are made using Balsamiq. I know. It's not open source.

Balsamiq supports versioning in the application - each .bmpr file can have 1) multiple designs, and 2) multiple versions (what they call "alternate" versions) of each design.

It doesn't support versioning with individual files well. (If I'm wrong, please correct me)

This basically means, to see each version of each design you need to have Balsamiq, or you/I have to export each design version to a .png.

User research

Design to-do list

  • create ssh aliases
  • create local-remote ssh tunnels
  • way to connect/disconnect ssh tunnels
  • need way for user to enter multiple local:port + remote:port combinations
  • create remote-local ssh tunnels
  • auto-select local port
  • add ssh-key path for each tunnel
  • add ssh password for each tunnel
  • Options, to include:
  • General
  • start mole in background
  • use ssh config file parameters
  • Specific tunnel options
  • skip host key validation
  • configure server connection timeout. Detailed in GH issue 12.
  • Server reconnect
  • configure "server reconnect" if connection it drops. Detailed in GH issue 24. (default on)
  • configure time to wait before server reconnect
  • configure number of reconnect retry attempts before giving up
  • Keep alive
  • configure "keep alive" . Detailed in GH issue 24. (default on)
  • configure persistent ssh connection. Detailed in GH issue 26. (default send packet every 10s, allow user to change)
  • add more things to this to-do list!
  • add way to view tunnel logs

Want to help?

1. Get Mole running

Install details are in the main repo.

2. Look at the docs

The documentation is probably a good place to start.

3. Look for a design issue

The Issues are located in David's repo. Have a look there for some design tickets.

4. Get in touch

License

These designs are licensed, like the Mole project, under MIT License.

About

This repo has UI designs for the Mole project, a cli SSH tunnel manager application.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published