Перейти до змісту

Конфігурація сервера

Якщо ви хочете змінити відкритий веб-календар відповідно до своїх потреб, це цілком можливо. Ви можете вибрати

  • Змінити вигляд календаря за замовчуванням.
  • Змінити роботу сервера.

Налаштування календаря за замовчуванням

Конфігурація всіх календарів базується на default_specification. Усі ці значення можна змінити за допомогою копії цього файлу, розміщеного в Інтернеті за допомогою параметра календаря specification_url. Кожен параметр має бути задокументований у default_specification.

Щоб змінити усі календарі, розміщені у вашому екземплярі, використовуйте змінну середовища OWC_SPECIFICATION. Календарі все ще замінюють деякі значення для їх конфігурації. На ті, які вони не перевизначають, впливає специфікація за замовчуванням. Не всі значення відображаються на сторінці конфігурації, яку потрібно змінити. Ці значення можна змінити в specification_url і параметрах запиту.

Ви можете змінити наступні значення.

title

Назва вашого сайту.

language

Це мова за умовчанням. Ви можете змінити це, щоб сторінка конфігурації була кращою для місцевої аудиторії.

favicon

Це посилання на значок веб-сайту.

source_code

Якщо ви внесли зміни, ви зобов’язані повідомити про них відвідувачам за законом. Відкоригуйте посилання або поверніть їх до основного проекту.

contributing

Якщо ви хочете перенаправити свій внесок у свій проект.

privacy_policy

Якщо ви самостійно розміщуєте цю службу, ви можете використовувати стандартну політику конфіденційності.

Якщо з якоїсь причини ви вирішите збирати дані, наприклад, у HTTPS-проксі або реєструвати IP-адреси, вам потрібно створити власну політику конфіденційності. Ви можете посилатися на один із цього проекту.

Більше цінностей

Є ще багато значень, які можна змінити. Будь ласка, зверніться до default_specification. Усі ці значення задокументовані. Щоб змінити їх, використовуйте змінну середовища OWC_SPECIFICATION.

Дивіться також:

Налаштування Сервера

Змінні середовища впливають лише на роботу сервера. Ці змінні середовища можна використовувати для налаштування служби:

ALLOWED_HOSTS

за замовчуванням порожній

Клієнти, розділені комами, яким дозволено доступ до відкритого веб-календаря. Ви побачите цей текст, якщо спробуєте отримати доступ до служби, але вам заборонено:

Forbidden: You don’t have the permission to access the requested resource. It is either read-protected or not readable by the server.*

Приклади:

  • дозволяти лише той самий комп’ютер: ALLOWED_HOSTS=localhost
  • дозволити декілька хостів: ALLOWED_HOSTS=192.168.0.1,192.168.2,api.myserver.com
  • дозволити всім доступ до сервера (за замовчуванням): ALLOWED_HOSTS= або ALLOWED_HOSTS=*

Цю функцію надає flask-allowed-hosts.

PORT

за замовчуванням 5000, за замовчуванням 80 в контейнері Docker

Порт, на якому працює служба.

Приклади:

  • Обслуговувати через порт HTTP: PORT=80

OWC_SPECIFICATION

OWC_SPECIFICATION – необов’язкова змінна середовища.

  • Це може бути шлях до файлу, що містить дійсний YAML або JSON.
  • Це може бути рядок, що містить дійсний YAML або JSON.

Налаштування OWC_SPECIFICATION дозволяє замінити значення за замовчуванням для всіх календарів.

Примітка

Нові версії Open Web Calendar можуть додавати нові параметри конфігурації. Внесення змін до цієї змінної замість зміни файлу default_specification гарантує, що ви не порушите відкритий веб-календар у майбутній версії.

У наступному прикладі буде змінено заголовок для всіх календарів, які не встановили власний заголовок.

OWC_SPECIFICATION='{"title": "calendar"}' gunicorn open_web_calendar:app

Дивіться також:

WORKERS

за замовчуванням 4, лише для контейнера Docker

Кількість паралельних працівників для обробки запитів.

Приклади:

  • Використовуйте лише один робочий файл: WORKERS=1

CACHE_REQUESTED_URLS_FOR_SECONDS

за замовчуванням 600

Секунди для кешування файлів календаря, які завантажуються, щоб зменшити пропускну здатність і затримку.

Приклади:

  • Швидке оновлення: CACHE_REQUESTED_URLS_FOR_SECONDS=10

APP_DEBUG

за замовчуванням true, значення true або false, завжди false у контейнері Docker

Установіть прапор налагодження для програми.

Подальша конфігурація

Відкритий веб-календар використовує бібліотеки, поведінку яких можна додатково налаштувати.

Захист SSRF за допомогою проксі-сервера

Відкритий веб-календар можна використовувати для доступу до локальної мережі за брандмауером, див. Випуск 250. Цей безкоштовний доступ призначений для показу календарів звідусіль. Оскільки запити використовуються Open Web Calender, він може використовувати проксі, як описано в документації щодо запитів. Після цього проксі-сервер зможе виконати фільтрацію.

export HTTP_PROXY="http://10.10.1.10:3128"
export HTTPS_PROXY="http://10.10.1.10:1080"
export ALL_PROXY="socks5://10.10.1.10:3434"

Дивіться також: