环境要求

操作系统

  • OSROOM支持Linux中部署, Windows未测试过
  • 建议使用Ubuntu >= 14.04版本;
  • 测试过操作系统有Ubuntu 14.04, 16.04, 18.04; Centos 6.5;
  • 其他Linux系统还未测试

Pyhotn要求

  • Python 3.4以上版本, 比如Python 3.4, Python 3.5, Python 3.6

Pyhton依赖包安装

创建Python虚拟环境(建议)

  • 例如在在/home/work创建名为venv-osroom的虚拟环境
  1. python -m venv /home/work/venv-osroom
  2. 或
  3. python3 -m venv /home/work/venv-osroom
  • 没有安装好python-venv请先安装, Ubuntu安装命令如下(注意py版本号):
  1. sudo apt-get install python3.6-venv

安装依赖包

  • 进入虚拟环境
  1.     source /home/work/venv-osroom/bin/activate
  2.     # 或
  3.     . /home/work/venv-osroom/bin/activate

  • 进入osroom项目根目录

  • 使用pip安装依赖包

  1. pip install -r requirements.txt

安装需求包异常情况

  • 情况1:类似以下错误信息
  1.  Command "/xxx/venv-osroom/bin/python3 -u -c "import setuptools, tokenize;
  3.  __file__='/tmp/pip-install-erphi6km/xxx/setup.py';
  5.  f=getattr(tokenize, 'open', open)(__file__);
  6.  code=f.read().replace('\r\n', '\n');f.close();
  7.  exec(compile(code, __file__, 'exec'))" install --record /tmp/pip-record-nhbhzs1a/install-record.txt
  8.   --single-version-externally-managed --compile
  9.   --install-headers /home/work/project/venv_osroom/include
  10.  site/python3.5/xxxx" failed with error code 1 in /tmp/pip-install-erphi6km/xxxx/

那么请尝试安装python-dev

Ubuntu系统:

  1.  # 不一定需要版本号
  3.  sudo apt-get install python3.5-dev

其他使用yum安装工具的Linux发行部系统:

  1.   # 不一定需要版本号
  2.  sudo yum install python3.5-devel
  • 情况2:类似错误信息
  1.  Command "python setup.py egg_info" failed with error code 1 in ...

那么请尝试安装 setuptools

  1.  pip install --upgrade setuptools

配置数据库

安装

初始化配置

因为osroom源代码只把数据库配置文件db_config.py的sample文件上传到git，所以请先复制修改名称

  1.  # 进入到apps/configs
  2.  cp db_config_sample.py db_config.py
  • 编辑db_config.py, 在配置中对应位置填写好数据库用户名和密码
  • 注意: redis数据库如果没有密码，则下面配置文件中redis的password为""就可以
  2.  DB_CONFIG = {
  3.     "redis": {
  4.         "password": "<Your password>",
  5.         "host": [
  6.             "127.0.0.1"
  7.         ],
  8.         "port": [
  9.             "6379"
  10.         ]
  11.     },
  12.     "mongodb": {
  13.         "mongo_web": {
  14.             "password": "<Your password>",
  15.             "username": "work",
  16.             "config": {
  17.                 "fsync": False,
  18.                 "replica_set": None
  19.             },
  20.             "host": [
  21.                 "127.0.0.1:27017"
  22.             ],
  23.             "dbname": "osr_web"
  24.         },
  25.         "mongo_user": {
  26.             "password": "<Your password>",
  27.             "username": "work",
  28.             "config": {
  29.                 "fsync": False,
  30.                 "replica_set": None
  31.             },
  32.             "host": [
  33.                 "127.0.0.1:27017"
  34.             ],
  35.             "dbname": "osr_user"
  36.         },
  37.         "mongo_sys": {
  38.             "password": "<Your password>",
  39.             "username": "work",
  40.             "config": {
  41.                 "fsync": False,
  42.                 "replica_set": None
  43.             },
  44.             "host": [
  45.                 "127.0.0.1:27017"
  46.             ],
  47.             "dbname": "osr_sys"
  48.         }
  49.     }
  50. }

初始化第一个用户

  • 进入项目的Python虚拟环境
  • 进入根目录运行start.py add_user 按如下操作和提示创建第一个用户
  1. (venv_osroom) work@osroom:~/project/osroom$ python start.py add_user
  2.  * [User] add
  3. Input username:root
  4. Input email:hehecdirr@163.com
  5. Input password(Password at least 8 characters):
  6. [Warning]: 密码至少8个字符！ 至少包含数字，字母，特殊字符中的任意两种
  8. Input password(Password at least 8 characters):
  9.  * Create root role...
  10. Create root user role successfully
  11.  * Create root user...
  12.  * Create a root user role successfully
  13.  * Create the average user role...
  14.  * Create a generic user role successfully
  15. The basic information is as follows
  16. Username: root
  17. Email: h*****irr@***.com
  18. User role: Root
  19. Password: #D****qw123
  20. End

访问测试

使用自带的服务测试是否能够成功运行osroom（测试用, 实际部署产品不会使用该方式启动运行）

启动OSROOM

  • 进入osroom项目目录
  1. # 如果需要外部访问，--host 为0.0.0.0 , --port 指定已开放的端口,默认5000
  2. python start.py runserver --host 127.0.0.1 --port 5000
  • 打开浏览器访问 127.0.0.1:5000