Create

Sign in to ReadmeX

or

How we handle your data: Privacy Policy

ReadmeX

Your AI reading companion

What would you like to catch up on?

Pick a briefing, or ask your own question.

Your community and people briefings stay personal to you.

lucky

lucky: A networking tool for personal and home networks with a web-based management interface.

What problem it solves

Personal and home networks often require several separate tools for dynamic DNS, local service access, certificates, file services, and device automation. Lucky brings these common networking tasks into one interface and originated as a way to forward traffic from public IPv6 to private IPv4 devices on a router.

Key features

  • Domains and Service Access — Manage dynamic DNS, reverse proxying, redirects, static websites, TCP/UDP port forwarding, and SSL/TLS certificate issuance and renewal.

    Source: README

  • NAT Traversal — Configure STUN, Cloudflared, and FRP functionality for network traversal, with requirements and server configuration depending on the selected solution.

    Source: README

  • Files and Storage Services — Use storage management and file services including WebDAV, Samba, FTP, FileBrowser, DLNA, and Rclone.

    Source: README, thirdlib

  • Devices and Automation — Control and automate devices through Wake-on-LAN, scheduled tasks, Docker management, a web terminal, and the light panel available through Web Services.

    Source: README, module

  • Security and Administration — Administer access with IP filtering, security groups, Coraza WAF, authentication options, Passkey management, centralized logs, and configuration backup and restore.

    Source: README

Quick start

Copied verbatim from the project's README.

docker run -d \
  --name lucky \
  --restart=always \
  --net=host \
  -v /root/luckyconf:/app/conf \
  gdy666/lucky:v3

Who it may suit

This project may suit home-network administrators and self-hosters who want to manage DNS, access to local services, files, and device automation through a web interface. Availability varies by build, platform, and runtime environment, so some features may require additional configuration.

Topics to discuss

  • Which modules are most useful in a typical personal or home-network setup?

  • How should network traversal options be evaluated for different public-address and router configurations?

  • What configuration backup, upgrade, and security practices should users follow across Lucky versions?


Written by ReadmeX AI from the project's README, source and public GitHub data; it may contain mistakes.

Read the original README https://github.com/gdy666/lucky#readme

ReadmeX opened this community for a trending project; it is not run by the project. Maintainers can claim it from the community page.

github.comhttps://github.com/gdy666/lucky

Comments

…