介绍
gollum-auth-shell 是一个 Node.js 模块,它提供了使用 Shell 账户进行认证而不是基于 HTTP 账户的 Gollum 服务器的能力。 Gollum 是 GitHub 的一个基于 Git 存储库的 wiki 系统。
如果您使用 Gollum 来管理您的项目文档,而您的团队成员都是 Shell 用户,那么 gollum-auth-shell 将是一个非常有用的工具。
安装
您可以在命令行中使用以下命令安装 gollum-auth-shell:
npm install -g gollum-auth-shell
使用
1. 配置 Gollum
首先,您需要在 Gollum 中设置 Shell 账户来接受身份验证。要做到这一点,您需要在 Gollum 的 config.rb
文件中添加以下行:
-- -------------------- ---- ------- ------- ------------- ------- ------------------- ---- - -------------------------------- - ---------- -- -------- -------- -- ----- -- --- --------------- ------------------------ ----------------------- - -------------- -- -------- - ------ --------- -- ----- -- ------- ------ ---- -- ----- --- -- ----- ------ -- ------ --------- -- ------ ------------- -- ----- -------------- -- ----- -------------- -- ----- ----------------- -- ----- --------------- -- ----- -------------------- -- ---- - ---- - -- -------- -- ------------------ ------------- -- ------------ ----------- -- ------ ----- -- -------------------- ----------------- -- ----------- -- ------ ------------- -- --- --------- -- --- ----------- -- ------ ------------ -- ---- -------------- -- ---- ---------- -- --- ------------- -- --- ----------- -- -------- - ------ ---- -------------- - ---- ------- -- ------------ -- --- --------- -- ------ --------- -- ----------------- ------------------ ------------ -- ------ --------------- -- ---------- ----------- -- ---- ------------- -- ------ --------------- -- ------ --------------- -- ----- --------- -- ----------- ------------- -- ---------------------- -------- -- ---------- --
在此示例中,您需要将 :authorized_users => {'youruser' => true}
更改为 Shell 用户名,以便 Gollum 可以通过 Shell 账户进行身份验证。 您还需要将 :ssh_user => 'youruser'
更改为 Shell 用户名。
2. 安装模块
npm install -g gollum-auth-shell
3. 启用 gollum-auth-shell
要使用 gollum-auth-shell,只需设置启动脚本的环境变量 GOLLUM_AUTH_SHELL_ENABLED
为 true
即可。环境变量的值可以在您的项目中通过以下方式设置:
export GOLLUM_AUTH_SHELL_ENABLED=true
当环境变量被设置为 true
时,Gollum 将使用 Shell 账户进行身份验证。
示例代码
以下是一个使用 gollum-auth-shell 的示例代码:
-- -------------------- ---- ------- --- ---- - ---------------- --- --- - --------------- --- ---- - ---------------- --- -- - -------------- --- ------------ - ------------------------- --- ------- - - ----- ----- ----- ---------------- ----------- ---------- ------------ -------------------------------- ---- ------------- -- --- ------ - ----------------------------------- --------------------------- ---------- - ------------------- ------ -- --------- -- - - ------------ - ------- ---
结论
通过使用 gollum-auth-shell,您可以使用 Shell 账户而不是 HTTP 账户进行 Gollum 服务器的身份验证。这非常适合 Shell 环境下的团队。在本文中,我们提供了使用 gollum-auth-shell 的详细说明和示例代码,希望能对您有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600558f081e8991b448d6436