Skip to content

Commit

Permalink
Locale specified in compose files and documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
impworks committed Apr 22, 2024
1 parent 4da7295 commit 1349624
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 9 deletions.
17 changes: 11 additions & 6 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bonsai

A family wiki and photoalbum engine (in Russian).
A family wiki and photoalbum engine.

### [Live demo](https://bonsai.kirillorlov.pro)

Expand Down Expand Up @@ -30,28 +30,33 @@ A family wiki and photoalbum engine (in Russian).
## Installation via Docker
1. Download the [docker-compose.lite.yml](docker-compose.lite.yml).

2. _Optional_:
2. Set the locale to English:

Modify `docker-compose.lite.yml`:
Change `Locale=ru-RU` to `Locale=en-US`.

3. _Optional_:

Configure your Bonsai instance to use HTTPS for better security.

You can use any vendor-specific options: e.g. Cloudflare Tunnel (free, fairly easy to configure, but requires a domain), Synology DDNS (free, very easy, requires a Synology NAS device), etc.

This requires a bit of work, so if you just want to give Bonsai a quick spin - feel free to skip or postpone this one and the next.

3. _Optional_:
4. _Optional_:

Create a [Google Authorization app](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/social/google-logins?view=aspnetcore-6.0) (or Yandex / VK.com).

Modify `docker-compose.lite.yml`:

* Save Google authorization credentials to `Auth__Google__ClientId` and `Auth__Google__ClientSecret` config properties
* Set `Auth__AllowPasswordAuth=false` if you want to disable the less-secure password authorization
* Set `Auth__AllowPasswordAuth=false` if you want to disable the less-secure password authorization

4. Bring everything up using `docker compose`:
5. Bring everything up using `docker compose`:
```
docker-compose -f docker-compose.lite.yml up -d
```
5. After everything is brought up Bonsai will listen on port `8080`.
6. After everything is brought up Bonsai will listen on port `8080`.

## Development (on Windows)

Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bonsai

Фамильный вики-движок и фотоальбом.
Фамильный вики-движок и фотоальбом на нескольких языках.

### [Демо: попробовать в действии](https://bonsai.kirillorlov.pro)

Expand Down Expand Up @@ -49,11 +49,16 @@
* Впишите данные для авторизации Google в поля `Auth__Google__ClientId` и `Auth__Google__ClientSecret`
* Задайте настройку `Auth__AllowPasswordAuth=false`, если хотите отключить менее безопасную авторизацию по паролю

4. Запустите все контейнеры с помощью `docker compose`:
4. _Опционально_:

Если вы хотите запустить Bonsai на языке, отличном от русского, поменяйте локаль в `docker-compose.lite.yml`:
Вместо `Locale=ru-RU` можно использовать `en-US`.

5. Запустите все контейнеры с помощью `docker compose`:
```
docker-compose -f docker-compose.lite.yml up -d
```
5. После старта Bonsai будет доступен на порту `8080`.
6. После старта Bonsai будет доступен на порту `8080`.

## Разработка (на Windows)

Expand Down
1 change: 1 addition & 0 deletions docker-compose.lite.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ services:
- ConnectionStrings__Database=
- ConnectionStrings__EmbeddedDatabase=Data Source=/app/App_Data/bonsai.db
- ConnectionStrings__UseEmbeddedDatabase=true
- Locale=ru-RU
- Auth__AllowPasswordAuth=true
- ASPNETCORE_ENVIRONMENT=Production
stop_signal: SIGKILL
Expand Down
1 change: 1 addition & 0 deletions docker-compose.postgres.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ services:
environment:
- ConnectionStrings__Database=Server=postgres;Port=5432;Database=bonsai;User Id=bonsai;Password=test;Persist Security Info=true
- Auth__AllowPasswordAuth=true
- Locale=ru-RU
- ASPNETCORE_ENVIRONMENT=Production
stop_signal: SIGKILL
links:
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ services:
- images:/app/wwwroot/media
environment:
- ConnectionStrings__Database=Server=postgres;Port=5432;Database=bonsai;User Id=bonsai;Password=test;Persist Security Info=true
- Locale=ru-RU
- Auth__AllowPasswordAuth=true
- Auth__Google__ClientId=
- Auth__Google__ClientSecret=
Expand Down

0 comments on commit 1349624

Please sign in to comment.