initialHEADmaster

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..866b339
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# TinyNAS
+
+Дистрибутив софта на базе докера для быстрого развертования домашнего NAS.
+
+В дистрибутив входят:
+
+* Transmission - торрент клиент
+* miniDLNA - DLNA сервер для трансляции скачанных файлов на ТВ/другие устройства
+* NextCloud - персональное облако
+* VaultWarden - селфхостед менеджер паролей, свободная реализация Bitwarden
+
+Помимо этого, сконфигурированы Caddy, Postgres, Redis чтобы всю эту красоту поддерживать.
+
+## Перед установкой:
+
+Требования для установки:
+
+* Сервер доступный снаружи
+* Домен который смотрит на этот сервер (его нужно будет указать в первом шаге установки)
+* docker + docker-compose
+
+## Установка:
+
+1. Запустить на сервере `./setup.sh` для генерации файла настроек .env
+2. Запустить TinyNAS: `docker compose up -d`
+
+## Использование
+
+Здесь и далее будет использоваться `example.com` как домен указанный 1 шаге установки
+
+### Transmission 
+
+Адрес: https://transmission.example.com/
+
+Логин: TRANSMISSION_USER из файла .env
+
+Пароль: TRANSMISSION_PASSWORD из файла .env
+
+### Nextcloud
+
+Адрес: https://nextcloud.example.com/
+
+Необходимо ввести новый логин и пароль для создания администратора. Нажать "Создать".
+
+После этого в какой-то момент будет ошибка таймаута браузера. Это *нормально*! 
+
+Ничего не делаем, обновляем страницу раз в пару минут, пока окно создания администратора не сменится на окно входа.
+
+Почему так - не знаю. Но оно работает. Пуллреквесты приветствуются.
+
+### VaultWarden
+
+Адрес: https://vaultwarden.example.com/
+
+Тут нет особенностей. Оно просто работает.
\ No newline at end of file