Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Usage of demo Dockerfile described.
  • Loading branch information
eao197 authored Jan 8, 2021
1 parent 7e9aa9b commit 2353ce8
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,39 @@ arataga создавался под следующие условия:

# Как взять и попробовать?

Компилятор с более-менее нормальной поддержкой C++17 (filesystem должен быть доступен "из коробки"), например, GCC-8 или более новый.
Потребуется компилятор с более-менее нормальной поддержкой C++17 (filesystem должен быть доступен "из коробки"), например, GCC-8 или более новый.

Операционная система GNU/Linux. У нас не было требований поддерживать другие ОС. Мы проверяли на Ubuntu 18.04 и 20.04.

## Как взять?
## Использование демонстрационного Dockerfile

Самый простой способ -- это использовать демонстрационный Dockerfile:

```sh
git clone https://github.com/Stiffstream/arataga
cd arataga
docker build -t arataga-ubuntu1804-gcc10 -f arataga-ubuntu1804-gcc10-local.Dockerfile .
docker run -p 5001:5001 -p 8088:8088 arataga-ubuntu1804-gcc10
```

Проверить работоспособность затем можно будет посредством команд вроде:

```sh
# Пытаемся загрузить страничку через прокси.
curl -x localhost:5001 -U user:12345 https://ya.ru
```

или

```sh
# Обращаемся к административному входу для списка работающих точек входа.
curl -H "arataga-admin-token: arataga-admin-entry" http://localhost:8088/acls

# Запрашиваем с административного входа текущие счетчики статистики.
curl -H "arataga-admin-token: arataga-admin-entry" http://localhost:8088/stats
```

## Как взять и собрать вручную?

В данном репозитории находятся только исходные тексты самих примеров. Исходные тексты зависимостей (т.к. asio, fmtlib, sobjectizer, doctest, restinio и пр.) в репозиторий не включены. Есть два способа взять примеры с необходимыми для них зависимостями.

Expand All @@ -59,8 +87,6 @@ arataga создавался под следующие условия:

После этого можно переходить к компиляции.

## Как попробовать?

### Компиляция посредством MxxRu

На данный момент поддерживается только сборка посредством MxxRu. Поэтому перед сборкой вам нужно будет установить Ruby и RubyGems (обычно RubyGems идет сразу с Ruby, но где-то может придется ставить отдельно), после чего выполнить установку MxxRu: `gem install Mxx_ru`.
Expand Down

0 comments on commit 2353ce8

Please sign in to comment.