Skip to content

m2sh/luci-app-rtty

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LuCI App for RTTY Remote Terminal

This LuCI application provides a web interface for managing RTTY remote terminal connections on OpenWrt devices.

Features

  • Multiple Server Support: Configure and manage multiple RTTY servers
  • Individual Server Configuration: Each server can have specific settings including:
    • Server host and port
    • Authentication token
    • SSL/TLS support
    • Username/password authentication
    • Custom descriptions
  • Enable/Disable Control: Enable or disable individual server connections
  • Service Management: Start, stop, and restart RTTY services through the web interface
  • Status Monitoring: View the status of active connections
  • Log Viewing: Access RTTY service logs

Installation

From Source

  1. Clone this repository to your OpenWrt build environment:

    git clone https://github.com/m2sh/luci-app-rtty.git
  2. Copy the application to your LuCI applications directory:

    cp -r luci-app-rtty /path/to/luci/applications/
  3. Build the package:

    make package/luci-app-rtty/compile
  4. Install the resulting package:

    opkg install luci-app-rtty_*.ipk

Dependencies

  • rtty - The RTTY client binary
  • luci - LuCI web interface framework

Configuration

UCI Configuration

The application uses UCI configuration stored in /etc/config/rtty:

# Global settings
config global 'rtty'
    option enabled '0'

# Server configurations
config server 'server1'
    option enabled '1'
    option name 'Default Server'
    option host 'rttys.net'
    option port '5912'
    option token ''
    option description 'Default RTTY server'
    option ssl '0'
    option username ''
    option password ''

Command Line Management

You can also manage RTTY services from the command line:

# Start all enabled servers
/etc/init.d/rtty start

# Start specific server
/etc/init.d/rtty start server1

# Stop all servers
/etc/init.d/rtty stop

# Stop specific server
/etc/init.d/rtty stop server1

# Check status
/etc/init.d/rtty status

# Check specific server status
/etc/init.d/rtty status server1

Usage

  1. Access the LuCI web interface
  2. Navigate to ServicesRTTY
  3. Configure your RTTY servers:
    • Click Add Server to create a new server configuration
    • Fill in the server details (host, port, authentication, etc.)
    • Enable the server by checking the Enabled checkbox
  4. Save and apply the configuration
  5. The RTTY service will automatically start for enabled servers

Server Configuration Options

  • Name: A friendly name for the server
  • Host: Server hostname or IP address
  • Port: Server port (default: 5912)
  • Token: Optional authentication token
  • Description: Optional description
  • SSL/TLS: Enable secure connection
  • Username: Optional username for authentication
  • Password: Optional password for authentication

Troubleshooting

Service Not Starting

  1. Check if the rtty binary is installed:

    which rtty
  2. Check the service logs:

    logread | grep rtty
  3. Verify the configuration:

    uci show rtty

Connection Issues

  1. Verify server host and port are correct
  2. Check if SSL/TLS settings match the server configuration
  3. Ensure authentication credentials are correct
  4. Check firewall rules if connecting to external servers

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

This project is licensed under the GNU General Public License v2.

Acknowledgments

About

Rtty Client UI for LuCI OpenWRT

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors