开始使用 OSS
GitPod
要启动 Logto 的在线 GitPod 工作区,点击这里。稍等片刻,你会看到如下信息:
Logto 默认使用端口 3001
作为其核心服务,端口 3002
用于交互式管理控制台。
要继续你的 Logto 之旅,按住 Ctrl(或 Cmd)并点击以 https://3002-...
开头的链接。享受吧!
本地
托管 Logto 的最低推荐硬件要求是:
- vCPU: 2
- 内存: 8 GiB
- 磁盘: 256 GiB
- Docker Compose
- Docker
- npm-init
Docker Compose CLI 通常与 Docker Desktop 一起提供。
不要在生产环境中使用我们的 docker compose 命令!由于我们目前在 docker-compose.yml
中将内置的 Postgres 数据库与 Logto 应用程序捆绑在一起,每次重新执行命令时都会创建一个新的数据库实例,之前持久化的任何数据都会丢失。
curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | docker compose -p logto -f - up
成功组合后,你会看到如下信息:
步骤 1
准备一个 PostgreSQL@^14.0 实例,并使用 Logto CLI 为 Logto 初始化数据库:
- CLI
- npx
logto db seed
npx @logto/cli db seed
步骤 2
拉取镜像:
# ghcr
docker pull ghcr.io/logto-io/logto:latest
# DockerHub
docker pull svhd/logto:latest
步骤 3
将容器端口映射到 Logto 核心和管理应用程序,例如,3001:3001
和 3002:3002
;并将以下环境变量设置到容器中:
TRUST_PROXY_HEADER: 1 # 如果你在 Logto 前面有 HTTPS 代理(例如 Nginx),请设置为 1
ENDPOINT: https://<your-logto-domain> # (可选)如果你使用自定义域,请替换为你的 Logto 端点 URL
ADMIN_ENDPOINT: https://<your-logto-admin-domain> # (可选)如果你使用自定义域,请替换为你的 Logto 管理 URL
DB_URL: postgres://username:password@your_postgres_url:port/db_name # 替换为你的 Postgres DSN
使用上述所有环境变量运行容器:
docker run \
--name logto \
-p 3001:3001 \
-p 3002:3002 \
-e TRUST_PROXY_HEADER=1 \
-e ENDPOINT=https://<your-logto-domain> \
-e ADMIN_ENDPOINT=https://<your-logto-admin-domain> \
-e DB_URL=postgres://username:password@your_postgres_url:port/db_name \
ghcr.io/logto-io/logto:latest
- 如果你使用 Docker Hub,请使用
svhd/logto:latest
而不是ghcr.io/logto-io/logto:latest
。 - 在
DB_URL
中使用host.docker.internal
或172.17.0.1
来引用主机 IP。
最后,你会看到如下信息:
先决条件
- Node.js
^18.12.0
- PostgreSQL
^14.0
更高版本通常可以工作,但不保证。
我们建议使用一个新的空数据库专用于 Logto,尽管这不是硬性要求。
下载并启动
在你的终端中:
npm init @logto@latest
一旦你完成初始化过程并启动 Logto,你会看到如下信息:
核心应用程序正在运行于 http://localhost:3001
核心应用程序正在运行于 https://your-domain-url
管理应用程序正在运行于 http://localhost:3002
管理应用程序正在运行于 https://your-admin-domain-url
前往 http://localhost:3002/
继续你的 Logto 之旅。享受吧!
使用备用 URL 下载
如果你想为 Logto zip 文件指定一个 URL,请使用 --download-url
选项。例如:
npm init @logto@latest -- --download-url=https://github.com/logto-io/logto/releases/download/v1.2.2/logto.tar.gz
注意需要额外的 --
以便 NPM 传递参数。
查看 核心服务 以获取更高级的控制或对 Logto 的编程访问。
创建账户
一旦你成功在服务器上托管 Logto,点击欢迎页面上的“创建账户”。请记住,Logto 的开源版本在初次启动时仅允许创建一个账户,并且不支持多个账户。账户创建过程仅限于用户名和密码组合。