Django Simple SSO 项目使用教程

Django Simple SSO 项目使用教程

django-simple-sso 项目地址: https://gitcode.com/gh_mirrors/dj/django-simple-sso

1. 项目目录结构及介绍

Django Simple SSO 是一个实现了单点登录（SSO）的开源项目，其目录结构如下：

• simple_sso/
  • __init__.py: 初始化模块。
  • models.py: 包含服务器端和客户端模型的定义。
  • views.py: 包含处理单点登录请求的视图函数。
  • urls.py: 包含 URL 模式，用于将 URL 映射到视图。
  • server/: 服务器端相关模块。
  • client/: 客户端相关模块。
• tests/
  • 包含项目的单元测试。
• setup.py: 包含项目的基本信息和安装脚本。
• README.rst: 项目的详细说明文档。
• LICENSE: 项目的许可协议。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

setup.py 是项目的启动文件，它定义了项目的包信息、依赖项以及如何安装项目。以下是一些关键部分：

• name: 项目的名称。
• version: 项目的版本号。
• install_requires: 项目依赖的 Python 包列表。
• packages: 指定项目包含的包。

要安装项目，可以运行以下命令：

pip install .

3. 项目的配置文件介绍

在 Django Simple SSO 中，主要的配置文件是 Django 项目的 settings.py 文件。下面是一些需要配置的设置项：

• INSTALLED_APPS: 确保 simple_sso.sso_server 被添加到应用的列表中。
• SIMPLE_SSO_SECRET: 客户端的密钥，用于签名请求。
• SIMPLE_SSO_KEY: 客户端的唯一标识符。
• SIMPLE_SSO_SERVER: 服务器端根 URL，用于单点登录。

以下是一个示例配置：

# settings.py

INSTALLED_APPS = [
    # ...
    'simple_sso.sso_server',
    # ...
]

SIMPLE_SSO_SECRET = 'your_secret_key'
SIMPLE_SSO_KEY = 'your_unique_key'
SIMPLE_SSO_SERVER = 'https://your_sso_server_url'

在完成这些配置之后，你就可以在你的 Django 项目中使用 Django Simple SSO 来实现单点登录功能了。

django-simple-sso 项目地址: https://gitcode.com/gh_mirrors/dj/django-simple-sso