https://github.com/rxxuzi/subway

https://github.com/rxxuzi/subway

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/rxxuzi/subway
• Owner: rxxuzi
• License: mit
• Created: 2024-08-29T10:39:39.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T14:21:44.000Z (4 months ago)
• Last Synced: 2024-09-14T12:13:26.512Z (3 months ago)
• Language: Go
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# subway

`subway` is a tool designed to make running anonymous web servers on the Tor network accessible to everyone.

## Features

- Publish local directories on the Tor network with ease

- Port forwarding to existing local servers

- Configurable via command-line arguments or JSON config file

- Automatic .onion address generation

## Quick Start

Serve a local directory:

```bash

subway -root ./public

```

This command will publish the contents of the `./public` directory on the Tor network and display the .onion address.

## Usage

### Command-line Options

- `-root `: Specify the root directory to serve (default: "./")

- `-port `: Set the local server port (default: 8864)

- `-tor `: Set the path to the Tor executable (default: "tor")

- `-pf `: Enable port forwarding (e.g., "localhost:8080")

- `-gen`: Generate a default config file

- `-load `: Load configuration from a specified file

- `-save `: Save current configuration to a specified file

### Configuration File

Place a `subway.json` file in the current directory to override default settings:

```json

{

  "root": "./public",

  "port": 8080,

  "torPath": "/usr/bin/tor",

  "portForwarding": ""

}

```

Note: Set `"portForwarding": ""` (empty string) to disable port forwarding and serve the local directory.

## Requirements

- Go 1.16 or later

- Tor

## License

This project is licensed under the MIT - see the [LICENSE](LICENSE) file for details.