Tinyauth 项目使用指南

Tinyauth 项目使用指南

tinyauth The simplest way to protect your apps with a login screen. 项目地址: https://gitcode.com/gh_mirrors/ti/tinyauth

1. 项目目录结构及介绍

Tinyauth 是一个简单的认证中间件，它可以为所有 Docker 应用添加基本的用户名/密码登录或 OAuth 认证（支持 Google、GitHub 和其他通用 OAuth 提供商）。以下是项目的目录结构及其简要介绍：

tinyauth/
├── .github/             # GitHub 相关配置文件
├── assets/              # 静态资源文件，如图片等
├── cmd/                 # 主应用程序的命令行接口
├── frontend/            # 前端代码，通常为 HTML、CSS 和 JavaScript 文件
├── internal/            # 内部应用程序和库代码
├── .env.example         # 环境变量配置文件示例
├── .gitignore           # Git 忽略文件列表
├── CODE_OF_CONDUCT.md   # 项目行为准则
├── CONTRIBUTING.md      # 贡献指南
├── Dockerfile           # Docker 容器构建文件
├── Dockerfile.dev       # 开发环境的 Dockerfile
├── FUNDING.yml          # 项目资金支持信息
├── LICENSE              # 项目许可证文件
├── README.md            # 项目自述文件
├── SECURITY.md          # 安全策略文件
├── air.toml             # 配置文件（可能是用于 CI/CD）
├── crowdin.yml          # 国际化配置文件
├── docker-compose.dev.yml # 开发环境的 Docker Compose 文件
├── docker-compose.example.yml # 示例 Docker Compose 文件
├── go.mod               # Go 依赖管理文件
├── go.sum               # Go 依赖校验文件
├── main.go              # 主应用程序入口文件

2. 项目的启动文件介绍

项目的启动文件为 main.go，这是 Go 语言编写的应用程序的入口点。以下是 main.go 的主要功能：

• 初始化配置
• 设置日志
• 设置 HTTP 服务和路由
• 启动 HTTP 服务器

启动文件示例代码（简化版）：

package main

import (
    "net/http"
)

func main() {
    // 初始化配置
    // 设置日志

    http.HandleFunc("/", handler)
    http.ListenAndServe(":8080", nil)
}

func handler(w http.ResponseWriter, r *http.Request) {
    // 处理 HTTP 请求
}

3. 项目的配置文件介绍

项目的配置文件主要有两个：.env.example 和 air.toml。

• .env.example：这是环境变量配置文件的示例，用于定义应用程序运行时所需的环境变量。在实际部署时，需要根据 .env.example 创建一个 .env 文件，并填写相应的值。

示例内容：

TINYAUTH_USERNAME=admin
TINYAUTH_PASSWORD=secret

• air.toml：这是配置文件，用于定义项目的各种配置项。这些配置项可能包括数据库连接信息、服务端口、OAuth 提供商的密钥和秘钥等。

配置文件示例（简化版）：

[service]
  port = 8080

[oauth]
  google_client_id = "your-google-client-id"
  google_client_secret = "your-google-client-secret"
  github_client_id = "your-github-client-id"
  github_client_secret = "your-github-client-secret"

请根据这些指南进行配置和启动您的 Tinyauth 项目。

tinyauth The simplest way to protect your apps with a login screen. 项目地址: https://gitcode.com/gh_mirrors/ti/tinyauth