jawanndenn 2.6.0

什么是jawanndenn？

jawanndenn是一个简单的Web应用程序，用于安排会议和进行投票，是Doodle的自由替代品。它使用以下技术

• Python

  • Docker Compose

  • Django

    • Django Extensions

    • Django Ratelimit + msgpack-python

    • django-redis

    • Django REST framework

    • Factory Boy

  • Gunicorn + gunicorn-color-logger

  • parameterized

  • pre-commit

  • python-rapidjson

  • sentry-python

  • wait-for-it

• JavaScript / CSS / 字体

  • Google Webfonts Helper

  • jQuery

  • jQuery noty

  • Materialize

  • Roboto

• 存储

  • PostgreSQL

  • Redis

  • SQLite

• 调度

  • Supercronic

jawanndenn 是由 Sebastian Pipping 开发的 自由软件。服务器代码采用 GNU Affero GPL 许可协议 第3版或更高版本进行许可，而客户端代码则采用 GNU GPL 许可协议 第3版或更高版本进行许可。

请报告错误并告诉我你是否喜欢它。

投票设置格式

标题为“设置（JSON）”的文本区域使用一个基于 JSON 的简单格式，支持以下键

• equal_width — 一个布尔值，用于控制是否将所有选项都泵送到相同的宽度（true 或 false），以抵消潜在选民偏差

• lifetime — 此投票将被删除后的持续时间；可以是 "week" 或 "month"；一个类似于枚举的字符串

• options — 一个字符串列表，每个选项一个字符串；支持类似 Markdown 的语法：粗体、斜体、内联代码

• title — 要运行的投票的标题或标题；支持类似 Markdown 的语法：粗体、斜体、内联代码

安装

要安装最新版本而不克隆 Git 仓库

# pip3 install jawanndenn --user

要从 Git 克隆安装

# ./setup.py install --user

使用 docker-compose 部署

创建一个简单的文件 .env，如下所示

JAWANNDENN_POSTGRES_NAME=jawanndenn
JAWANNDENN_POSTGRES_USER=jawanndenn
JAWANNDENN_POSTGRES_PASSWORD=dEb2PIcinemA8poH
JAWANNDENN_SECRET_KEY=606ea88f183a27919d5c27ec7f948906d23fdd7821684eb59e8bcf7377e3853b

复制粘贴后，请确保调整这些值！

然后，您可以使用 docker-compose up --build 命令构建并运行一个 Docker 镜像。

应用程序在 localhost:54080 上提供服务。PostgreSQL 数据保存在主机系统的 ~/.jawanndenn-docker-pgdata/ 上。还有一个用于跨进程速率限制的 Redis 实例，以及一个“cron”维护容器，该容器每 60 分钟删除已超出配置生命周期的投票。

（如果您需要在 jawanndenn 前面需要一个低维护成本的 SSL 反向代理，那么 docker-ssl-reverse-proxy 可能会引起您的兴趣。）

还有一些其他的环境变量，您可能需要在环境中调整。总共有以下变量

命令行用法

安装后，调用非常简单

# jawanndenn

在开发期间，您可能想使用以下命令从 Git 克隆运行 jawanndenn

# PYTHONPATH=. python3 -m jawanndenn --debug

目前支持的参数有

# jawanndenn --help
usage: jawanndenn [-h] [--debug] [--host HOST] [--port PORT]
                  [--url-prefix PATH] [--database-sqlite3 FILE]
                  [--django-secret-key-file FILE] [--max-polls COUNT]
                  [--max-votes-per-poll COUNT] [--dumpdata]
                  [--loaddata FILE.json]

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug mode (default: disabled)
  --host HOST           Hostname or IP address to listen at (default:
                        127.0.0.1)
  --port PORT           Port to listen at (default: 8080)
  --url-prefix PATH     Path to prepend to URLs (default: "")
  --database-sqlite3 FILE
                        File to write the database to (default:
                        ~/jawanndenn.sqlite3)
  --django-secret-key-file FILE
                        File to use for Django secret key data (default:
                        ~/jawanndenn.secret_key)

limit configuration:
  --max-polls COUNT     Maximum number of polls total (default: 1000)
  --max-votes-per-poll COUNT
                        Maximum number of votes per poll (default: 40)

data import/export arguments:
  --dumpdata            Dump a JSON export of the database to standard output,
                        then quit.
  --loaddata FILE.json  Load a JSON export of the database from FILE.json,
                        then quit.

从 jawanndenn 1.x 迁移数据到 2.x

迁移分为四个步骤

1. 更新到 jawanndenn 1.x 的最新版本，例如：运行 pip2 install --upgrade 'jawanndenn<2'；JSON 数据导出首次在版本 1.6.3 中引入。

2. 导出现有的投票

   1. 如果您正在使用命令行应用程序：python2 -m jawanndenn --dumpdata > dump.json

   2. 如果您正在使用 docker-compose：docker-compose run -T jawanndenn --database-pickle /data/polls.pickle --dumpdata > dump.json

3. 在某处部署最新的 jawanndenn 2.x（如上所述）或只需在某处运行 pip3 install 'jawanndenn>=2'

4. 导入步骤（2）中创建的 JSON 导出

   1. 如果您正在使用命令行应用程序：python3 -m jawanndenn --loaddata dump.json

   2. 如果您正在使用 docker-compose：docker-compose run -T jawanndenn sh -c 'cat > /tmp/dump.json && DJANGO_SETTINGS_MODULE=jawanndenn.settings python3 -m django loaddata /tmp/dump.json' < dump.json

目标

• 可以自己托管的开源软件，不同于 Doodle

• 比 开源替代品 更简单、更性感或更有趣，按字母顺序排列

  • Bitpoll（例如 Dudel）

  • Croodle

  • Dudle

  • （Drupal 日期选择器格式化程序）

  • （Foodle（已停用；GitHub 上的 Foodle，例如 DFN 计划器，例如 DFN Terminplaner+））

  • Framadata (源代码，例如 OpenSondage，例如 STUdS))

  • Nextcloud 投票

  • Noodle

  • Nuages

  • Pleft

  • Rallly

  • RDVz

  • sowhenthen

• 保持简单、易用、可维护

• 支持从命令行调用，例如用于局域网中的即兴投票

• 考虑安全性

请查看即将推出的功能列表。

非目标

• 使用重型前端框架：仅作为构建块

• 从日历读取可用性

感谢

特别感谢 Arne Maier (@KordonDev) 负责任地报告了 XSS 漏洞。