martin888/tunasync repository overview

⁠tunasync Docker Image Usage Guide

Welcome to the tunasync Docker image! This guide will provide you with the necessary steps to run the image and configure it according to your needs.

⁠Overview

The tunasync image is designed to provide a flexible and efficient environment for managing asynchronous tunnel services. It includes a variety of tools and configurations to ensure a seamless setup and operation.

⁠Running the Container

To run the tunasync container, use the following command:

docker run -it \
  --rm \
  -v ./nginx:/etc/nginx \
  -v ./demo:/tunasync \
  -v ./data:/data \
  -p 51580:51580 \
  -p 51581:51581 \
  -p 23456:23456 \
  -p 23455:23455 \
  -e ALICLOUD_ACCESS_KEY=xxx \
  -e ALICLOUD_SECRET_KEY=xxx \
  -e LEGO_DOMAIN=xxx \
  -e LEGO_DNS_PROVIDER=xxx \
  -e LEGO_DNS_RESOLVERS="xxxx" \
  -e LEGO_EMAIL="xxx" \
  --name=tunasync \
  martin888/tunasync:latest

Please replace the xxx placeholders with your actual Alibaba Cloud access key, secret key, domain, DNS provider, DNS resolvers, and email address.

⁠Volumes

The following volumes are mounted to the container:

• ./nginx:/etc/nginx: This maps your local nginx directory to the /etc/nginx directory inside the container, allowing you to customize the Nginx configuration.
• ./demo:/tunasync: This maps your local demo directory to the /tunasync directory inside the container, which can be used to store your tunasync-related files.
• ./data:/data: This maps your local data directory to the /data directory inside the container, which is intended for storing persistent data.

⁠Ports

The following ports are exposed and mapped to the host:

• 51580 and 51581: These are the default ports used by tunasync.
• 23456 and 23455: These ports can be used for additional services or configurations as needed.

⁠Environment Variables

The following environment variables are used to configure the container:

• ALICLOUD_ACCESS_KEY and ALICLOUD_SECRET_KEY: These are your Alibaba Cloud credentials for accessing their services.
• LEGO_DOMAIN: The domain for which you want to acquire SSL certificates using Lego.
• LEGO_DNS_PROVIDER: The DNS provider to be used with Lego for automatic certificate renewal.
• LEGO_DNS_RESOLVERS: The DNS resolvers to be used by Lego.
• LEGO_EMAIL: The email address to be used by Lego for account registration and communication.

⁠Important Notes

• The --rm flag is used to automatically remove the container when it exits. This helps to keep your environment clean by removing any stopped containers.
• The -e flag is used to set environment variables, which are essential for the proper functioning of the container.
• The --name flag assigns a name to the container, making it easier to reference in subsequent commands.

⁠help

• email: [email protected]⁠