d-note 项目安装与部署指南

项目概述

d-note 是一个基于 Python Flask 框架开发的轻量级 Web 应用程序，主要用于安全笔记管理。本文将详细介绍如何在 Linux 系统上安装和部署 d-note 项目，包括 Apache 和 Nginx 两种主流 Web 服务器的配置方案。

环境准备

系统要求

• Debian/Ubuntu 系统（其他 Linux 发行版可参考类似步骤）
• Python 运行环境
• Web 服务器（Apache 或 Nginx）

依赖安装

首先需要安装必要的 Python 依赖包：

sudo apt-get install python-flask python-crypto

注意：python-crypto 包应确保来自官方源，这是加密功能正常运行的关键依赖。

项目配置

初始化安装

执行以下命令完成基础安装：

python setup.py install

此命令会创建必要的配置文件和数据存储目录。

配置文件设置

1. 编辑项目目录中的 dnote.ini 文件
2. 修改 [default] 部分下的 config_path 值
   • 推荐路径：/etc/dnote 或 ~/.dnote
3. 将修改后的 dnote.ini 复制到指定目录

生成安全哈希

运行以下命令生成安全配置：

generate_dnote_hashes

此命令会在配置目录中创建 dconfig.py 文件，其中包含随机生成的十六进制字符串作为加密盐值，这是保证数据安全的重要步骤。

Apache 部署方案

安装必要组件

sudo apt-get install libapache2-mod-wsgi

创建 WSGI 入口文件

在 Web 根目录创建 /var/www/dnote.wsgi 文件，内容如下：

#!/usr/bin/python
import sys
import logging
logging.basicConfig(stream=sys.stderr)
from dnote import DNOTE as application

Apache 站点配置

创建 /etc/apache2/site-available/ 配置文件，以下是关键配置示例（强烈建议使用 SSL）：

<Virtualhost *:443>
    DocumentRoot /var/www/
    ServerName www.example.com
    WSGIScriptAlias / /var/www/dnote.wsgi
    
    <Directory /var/www/>
        Options -Indexes FollowSymLinks
    </Directory>
    
    Alias /d/static /var/www/dnote/static
    <Directory /var/www/dnote/static/>
        Order allow,deny
        Allow from all
    </Directory>

    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/www_example_com.crt
    SSLCertificateKeyFile /etc/ssl/private/www_example_com.key
    SSLHonorCipherOrder On
</VirtualHost>

重启 Apache 服务

sudo service apache2 restart

Nginx 部署方案

安装 uWSGI

sudo apt-get install uwsgi uwsgi-core uwsgi-extra uwsgi-plugin-python

创建 uWSGI 配置文件

在应用目录创建 /var/www/dnote/uwsgi.ini：

[uwsgi]
socket = 127.0.0.1:8081
chdir = /python/path/site-packages/dnote-1.0.1-py2.7.egg/dnote
plugin = python
module = __init__:dnote
processes = 4
threads = 2
stats = 127.0.0.1:9192
uid = www-data
gid = www-data
logto = /var/log/dnote.log

启动 uWSGI

前台运行：

/usr/bin/uwsgi -c /var/www/dnote/uwsgi.ini

后台运行：

/usr/bin/uwsgi -d -c /var/www/dnote/uwsgi.ini

Nginx 配置

在站点配置中添加以下内容（示例为将应用部署在 /dnote 路径下）：

location = /dnote { rewrite ^ /dnote/; }
location /dnote/ { try_files $uri @dnote; }
location @dnote {
    include uwsgi_params;
    uwsgi_param SCRIPT_NAME /dnote;
    uwsgi_modifier1 30;
    uwsgi_pass 127.0.0.1:8081;
}

重启 Nginx

sudo service nginx restart

常见问题排查

1. 内部服务错误

   • 检查 /var/www/dnote/dnote 目录是否对 Web 服务器可读
   • 确保 /var/www/dnote/dnote/data/hashcash.db 文件可写

2. uWSGI 启动问题

   • 可尝试使用 WSGI 文件方式启动，修改 uwsgi.ini：

     wsgi-file = /var/www/dnote.wsgi
     

     替代原来的 module 配置

3. 权限问题

   • 确保所有相关文件和目录的所有权和权限设置正确
   • 特别是当使用不同用户运行 Web 服务器和 uWSGI 时

安全建议

1. 始终使用 HTTPS 加密连接
2. 定期备份 hashcash.db 文件
3. 限制对管理接口的访问
4. 保持系统和依赖包的最新状态

通过以上步骤，您应该能够成功部署 d-note 项目。根据实际环境需求，可能需要对配置进行适当调整。