This repository has been archived by the owner on Nov 30, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add russian readme and installation/running instructions
- Loading branch information
Showing
2 changed files
with
69 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# CTFhost | ||
Платформа для проведения соревнований по компьютерной безопасности в формате Task-Based CTF. | ||
Проект по программированию. | ||
|
||
## Запуск | ||
**Примечание**: Описывается процесс для ОС Linux, однако он же должен сработать и под macOS, и под Windows | ||
(для этих операционных систем процесс установки Python и нужных библиотек может немного отличаться, подробнее | ||
про запуск под Windows я напишу немного позднее). | ||
|
||
Шаги *"Установка Python"* — *"Включение русского языка"* нужно выполнять только при первом запуске. | ||
|
||
### Установка Python | ||
Для работы необходим Python 3. Желательно использовать версию 3.7 или выше. Если Python нужной версии у вас уже | ||
установлен, можете пропустить этот шаг. | ||
|
||
Алгоритм установки: | ||
|
||
- Debian/Ubuntu-based Linux: `sudo apt-get install python3` | ||
|
||
- Arch Linux: `sudo pacman -S python` | ||
|
||
- macOS (необходим [Homebrew](https://brew.sh/)): `brew install python` | ||
|
||
- Windows: Скачать и установить Python 3 [отсюда](https://www.python.org/downloads/windows/), при установке | ||
отметить галочку *"Add Python 3.7 to PATH"* или подобную. | ||
|
||
### Установка пакетов | ||
Необходимо выполнить команду: `pip install -r requirements.txt`, находясь в папке с проектом (в ней должен | ||
находиться файл `requirements.txt`) | ||
|
||
### Подготовка базы данных | ||
Предполагается, что перед выполнением этого шага вы находитесь в папке с проектом. | ||
|
||
Необходимо выполнить команды (независимо от ОС): | ||
|
||
``` | ||
cd db | ||
python3 bootstrap_db.py | ||
cd .. | ||
``` | ||
|
||
При этом будет выведен пароль администратора (root). Запомните его, он понадобится для входа в систему. | ||
|
||
### Включение русского языка (опционально) | ||
Если вы хотите включить русский язык, то вам нужно отредактировать файл `configuration.py`, заменив `'en_US'` | ||
на `'ru_RU'` в 13 строчке. | ||
|
||
### Запуск сервера | ||
Предполагается, что перед выполнением этого шага вы находитесь в папке с проектом. | ||
|
||
Необходимо выполнить команду `python3 main.py`. | ||
|
||
После этого сервис станет доступным по ссылке: [http://localhost:8888](http://localhost:8888). | ||
|
||
Для входа в систему воспользуйтесь следующими учётными данными: | ||
- Имя пользователя: `root` | ||
- Пароль: пароль, полученный на шаге *"Подготовка базы данных"* | ||
|
||
## Использованные библиотеки | ||
- [Ace](https://ace.c9.io/) - Веб-редактор кода | ||
- [W3.CSS](https://www.w3schools.com/w3css/) - Таблицы стилей | ||
- [Loguru](https://github.com/Delgan/loguru) - Ведение логов | ||
- [Pygments (ссылка без HTTPS)](http://pygments.org/) - Подсветка кода | ||
- [Markdown (пакет Python)](https://python-markdown.github.io/) - Форматирование текста заданий | ||
И другие (например, `sqlite3`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,13 @@ | ||
# ctfhost | ||
# CTFhost | ||
A simple platform to hold task-based CTF competitions. Programming project | ||
|
||
Russian version of this document is available in [README.RU.md](README.RU.md) | ||
|
||
## Acknowledgements | ||
|
||
- [Ace](https://ace.c9.io/) - Code editor | ||
- [W3.CSS](https://www.w3schools.com/w3css/) - Frontend CSS | ||
- [Loguru](https://github.com/Delgan/loguru) - Logging | ||
- [Pygments (no HTTPS in the link)](http://pygments.org/) - Source highlighting | ||
- [Markdown (Python package)](https://python-markdown.github.io/) - Task text formatting | ||
|
||
And other libraries (e.g. `sqlite3`) |