Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

config.py配置说明

Jump to bottom
Junbo Wang edited this page May 7, 2016 · 2 revisions

open-hackathon共两个config_sample.py文件，分别用来配置open-hackathon-server和open-hackathon-client。使用时应先将相应的config_sample.py在其目录下复制并改名为config.py。

server端config.py配置说明

  1. MONGODB_HOST, MONGODB_PORT, MONGODB_DB： mongodb数据库服务器的IP地址、端口号及open-hackathon使用的数据库名称，mongodb部署在本地时，可以设置MONGODB_HOST = localhost，否则应为数据库服务器所在IP；
  2. HACKATHON_SERVER_ENDPOINT：open-hackathon-server运行服务器的IP地址+监听的端口号，本地开发可以配置为HACKATHON_SERVER_ENDPOINT = "localhost:15000"，实际部署时应为服务器的公网IP＋“:”+监听的端口号；
  3. environment: 为参赛者分配虚拟机时使用的云资源，local表示使用本地（一般为开发者使用），非开发环境请修改为其它值，比如"production"；
  4. endpoint： 参考HACKATHON_SERVER_ENDPOINT；
  5. app
    1. secret_key：用于加密secure session，可以为任意字符串,但必须与open hackathon client端保持一致。, 为安全考虑，应该长度不低于20位且包含数字，字母及特殊字符；
  6. mongodb：mongodb的配置信息，参考MONGODB_HOST, MONGODB_PORT, MONGODB_DB；
  7. login
    1. token_expiration_minutes：代表用户使用token认证登录的最长有效时间；
  8. azure
    1. cert_base：创建黑客松活动过程中，会使用创建者提供的订阅号来生成cer和pem文件，cert_base代表生成文件存放在服务器的位置，一般不需要修改；如果需要修改，请确保运行程序对修改后的路径具有读写权限；
  9. guacamole
    1. host：guacamole的监听地址，为IP地址+“:”+监听端口号；由于guacamole client作为tomcat的插件运行，所以端口号为tomcat默认监听的端口号8080，一般不需要修改。如果需要修改，请先修改tomcat监听的端口号，若guacamole部署在本地为localhost:8080；
  10. scheduler：定时任务存储在数据库中，这里配置用于存储定时任务的数据库信息，一般不需要修改；
  11. job_store：定时任务存储时选用的数据库技术，默认为mongodb；
  12. database：定时任务存储在哪个数据库里面，默认为MONGODB_DB；
  13. collection：定时任务对应database中哪个collection，默认为jobs；
  14. host：数据库服务器IP地址；
  15. port：数据库服务器监听端口；
  16. storage 云存储技术相关配置,将会保存模板文件，azure证书，用户上传的文件等。
  17. type：local代表存储在本地，azure代表存储在azure上面；
  18. size_limit_kilo_bytes：单次上传文件大小的最大值；
  19. azure：如果type类型选择azure，则需要配置
    1. account_name：azure账户名；
    2. account_key：key；
    3. image_container：设置云上或本地存储image的路径；
    4. template_container：设置云上或本地存储template的路径；
    5. certificates_container：设置云上或本地存储certificate的路径；
    6. blob_service_host_base：云服务的基本路径，使用中国的azure服务无需修改，如使用其它地区的azure服务，可以查询所在地区azure提供商的官方介绍；
  20. docker docker可以在本地（本地开发使用），azure和灵雀云上运行，创建容器。如果选择前面两者，则不需要修改设置该项配置，在灵雀云上运行，可以参考灵雀云官方介绍修改以下参数
  21. alauda
    1. token：token；
    2. namespace：命名空间；
    3. endpoint：灵雀云服务器地址；
    4. region_name：灵雀云服务器所在地区；
  22. email：配置email信息，open-hackathon提供管理员向注册者发送邮件的服务
  23. host：邮件服务器地址；
  24. port：邮件服务器端口；
  25. username：管理员用于发送邮件的邮箱地址；
  26. password：管理员邮箱密码；
  27. voice_verify：用于语音认证
  28. enabled：是否开启；
  29. provider：
  30. rong_lian：
    1. account_sid：
    2. auth_token：
    3. app_id：
    4. server_ip：
    5. server_port：
    6. soft_version：
    7. play_times：
    8. display_number：
    9. response_url：
    10. language
  31. sms： 短信服务，open-hackthon提供向报名者发送短信的服务
  32. enabled：是否开启
  33. provider： 3： china_telecom：服务商为中国电信
    1. url
    2. app_id
    3. app_secret
    4. url_access_token

client端配置config.py

  1. HOSTNAME：外部访问open-hackathon的地址，值为open-hackathon-client部署在的服务器对应的域名，如HOSTNAME = "http://hacking.kaiyuanshe.cn"；
  2. HACKATHON_API_ENDPOINT：open-hackathon-client调用open-hackathon-server的服务，值应为server端配置文件config.py中的HACKATHON_SERVER_ENDPOINT；
  3. GITHUB_CLIENT_ID和GITHUB_CLIENT_SECRET：Github OAuth登录，用于配置Github账户登录open-hackathon，参考github文档；
  4. QQ_CLIENT_ID、QQ_CLIENT_SECRET、QQ_META_CONTENT、QQ_OAUTH_STATE：QQ OAuth登录，用于配置QQ账户登录open-hackathon，参考qq文档；
  5. WECHAT_APP_ID、WECHAT_SECRET、WECHAT_OAUTH_STATE：微信 OAuth登录，用于配置微信账户登录open-hackathon，参考微信文档；
  6. GITCAFE_CLIENT_ID、GITCAFE_CLIENT_SECRET：gitcafe OAuth登录，用于gitcafe账户登录open-hackathon；
  7. WEIBO_CLIENT_ID、WEIBO_CLIENT_SECRET、WEIBO_META_CONTENT：微博OAuth登录，用于配置微博账户登录open-hackathon，参考微博文档；
  8. LIVE_CLIENT_ID、LIVE_CLIENT_SECRET：微软Live OAuth登录，用于微软 Live账户登录open-hackathon，参考微软Live文档；
  9. ALAUDA_CLIENT_ID、ALAUDA_CLIENT_SECRET：灵雀云 OAuth登录，用于灵雀云账户登录open-hackathon，参考官方文档；
  10. environment：参考server端配置中的environment；
  11. app
  12. secret_key：参考server配置；
  13. login：OAuth登录认证配置
  14. github、qq、wechat、gitcafe、weibo、live、alauda：各种OAuth登录配置，具体参数可以参考第3~8条及对应官方文档说明，一般不需要修改；
  15. provider_enabled：选择使用的登录方式，如选择github和微信，则设置为"provider_enabled": ["github", "wechat"]；
  16. token_expiration_seconds：OAuth认证的有效时间；
  17. hackathon-api
  18. endpoint：参考HACKATHON_API_ENDPOINT；
  19. javascript
  20. github、qq、wechat、gitcafe、weibo、live、alauda：OAuth登录时，重定向到相应的认证提供中心的链接，一般不需要修改；
  21. hackathon：参考HACKATHON_API_ENDPOINT；
  22. apiconfig：配置open-hackathon-server提供的restful api集合；在开发过程中，如果后台增加了新的restful，需要在这里相应增加；
Clone this wiki locally