docs(passport): config passport-github behind of proxy

[thonatos]

Checklist

• npm test passes
• tests and/or benchmarks are included
• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

Description of change

[thonatos]

Egg 部署于 Nginx 之后并启用 SSL， 无法正确获取协议并提示 error=redirect_uri_mismatch

why

• passport-oauth2 strategy.js#L141
• passport-oauth2 utils.js#L18

how

// {APP_ROOT}/config/config.{env}.js

// proxy
exports.proxy = true;

// passport
exports.passportGithub = {
  key: process.env.EGG_PASSPORT_GITHUB_CLIENT_ID || 'test',
  secret: process.env.EGG_PASSPORT_GITHUB_CLIENT_SECRET || 'test',
  callbackURL: process.env.EGG_PASSPORT_GITHUB_CALLBACK_URL || '/passport/github/callback',
  proxy: process.env.EGG_PROXY === 'proxy',
};
  

nginx

docker-compose.yml

version: '3'
services: 
  proxy:
    image: nginx:stable-alpine
    ports:
      - 80:80
      - 443:443      
    volumes:
      - ./ext/default.conf:/etc/nginx/conf.d/default.conf
      - ~/.acme.sh/*.implements.io:/etc/nginx/ssl/

default.conf

server {
    listen              443 ssl;
    server_name         dockerizer.implements.io;
    ssl_certificate     /etc/nginx/ssl/fullchain.cer;
    ssl_certificate_key /etc/nginx/ssl/*.implements.io.key;
    ssl_protocols       TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers         HIGH:!aNULL:!MD5;

    location / {
	set $proxied_server {YOUR_IP}:7001;
 	proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto https;
        proxy_set_header X-NginX-Proxy true;
        proxy_redirect off;
        proxy_pass http://$proxied_server;
    }    
} 

备注：

• 更改 {YOUR_ID} 为自己的ip（注意不要用127.0.0.1）
• 证书自行准备

[popomore]

这个 proxy 是不是加错了

[thonatos]

这里还是得加：

1. config.proxy = true; 是正确设置
2. utils.js 里 app.get 是 undefined, 判断不了 proxy 是否开启
3. 通过 egg-passport-github 的 options 把 proxy 传给 passport-oauth2 应该算 trick 了

[popomore]

喔，我以为是下面说的 config.proxy

[thonatos]

嗯嗯，这里是两个选项：

• config.proxy = true
• config.passportGithub.proxy = true

线上在跑了，应该没毛病

[popomore]

确实可以附加一个简化的 nginx 配置。

[thonatos]

加在上面了，😀

[codecov]

Codecov Report

Merging #2318 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2318   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files          29       29           
  Lines         749      749           
=======================================
  Hits          746      746           
  Misses          3        3

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 24d842c...360ae47. Read the comment docs.