Skip to content

KimYoungNo/ttyd-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ttyd-service

ttyd-service installer for Linux

Please visit the ttyd repository for more information.

Features

  • Interactive configuration with whiptail
  • Automatic conflict detection on Service name & Port number
  • Fully customizable ExecStart & WorkingDirectory
  • Single script execution

List of supported Distribution:

  • Debian

How to Install

Copy & paste the below command in the terminal:

bash -c "$(wget -qLO - https://raw.githubusercontent.com/KimYoungNo/ttyd-service/refs/heads/main/ttyd-service-install.sh)"

Procedure

After executing the command above, the next procedures automatically start:

  1. System package updates & upgrade
  2. Dependency installation
  3. ttyd installation & compilation
  4. ttyd-service configuation
  5. Service unit create & enable

Simple Demo with nvtop

In procedure 4, you will see the configuration screen.


ttyd-nvtop-service-name

The first configuration is Service Name. It is the name of your service unit file.

Default: ttyd-service


ttyd-nvtop-service-name-conflict

If the name is already in use, it will pop up a service name conflict warning. You can choose one between overwriting or suspending.

yes: delete and regenerate the service

no: suspend the installation immediately


ttyd-nvtop-port

The second configuration is Port Number. It is the serving port of your ttyd.

Default: 7681


ttyd-nvtop-port-conflict

If the port is already busy, it will pop up a service port conflict warning. The only thing possible is changing your port number.


ttyd-nvtop-cwd

Third configuration is WorkingDirectory. It becomes the WorkingDirectory line of the service unit file.

Default: /usr/bin


ttyd-nvtop-exec

The last configuration is ExecStart. It becomes the ExecStart line of the service unit file.

It is automatically filled out with an absolute path of the ttyd binary and port argument.

You should enter your argument (or command); otherwise, the service will fail (invalid ExecStart).

To fill out ExecStart, please visit the ttyd repository for command line arguments and options.


ttyd-nvtop-complete

Here is the screen after finishing the installation. You can use your ttyd-service through the suggested URL at the bottom.


ttyd-nvtop-demo

And here is the screen that shows how actually the nvtop is shared through ttyd. You can access all functionality of nvtop if --writable (or -W) option is set.

About

ttyd-service installer for Linux

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages