https://github.com/tyler36/ddev-locale

Change a DDEV project's timezone and language.
https://github.com/tyler36/ddev-locale

ddev ddev-get locale

Last synced: 5 months ago
JSON representation

Change a DDEV project's timezone and language.

• Host: GitHub
• URL: https://github.com/tyler36/ddev-locale
• Owner: tyler36
• License: apache-2.0
• Created: 2024-06-06T02:37:44.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-06T04:36:44.000Z (6 months ago)
• Last Synced: 2025-01-06T05:25:50.753Z (6 months ago)
• Topics: ddev, ddev-get, locale
• Language: Shell
• Homepage:
• Size: 70.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![tests](https://github.com/tyler36/ddev-locale/actions/workflows/tests.yml/badge.svg)](https://github.com/tyler36/ddev-locale/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2026.svg)

# ddev-locale 

- [What is ddev-locale?](#what-is-ddev-locale)

- [Why ddev-locale?](#why-ddev-locale)

- [Getting started](#getting-started)

- [Configuration](#configuration)

  - [Change timezone](#change-timezone)

  - [Change locale](#change-locale)

- [Components of the repository](#components-of-the-repository)

- [Contributing](#contributing)

## What is ddev-locale?

DDEV-locale is design to setup the DDEV web container for a specific locale.

In additional, it serves as documentation for DDEV internationalization.

DDEV has 2 related locale settings:

- timezone.

- system locale.

This addon, by default, sets both of these to Japan (Japanese).

Why Japan? Japan has a single timezone and a single encoding locale. It is also where my team is based.

## Why ddev-locale?

DDEV allows encoding to be set globally (via `web-environment`).

Timezone, however, is a per-project setting.

As of writing, DDEV includes all language files which significantly inflates the web server container size.

If/when the language files are removed, this addon will be updated to install the language pack.

## Getting started

1. Install this addon.

    ```shell

    ddev addon get tyler36/ddev-locale

    ddev restart

    ```

## Configuration

To change either setting, you need to update `.ddev/config.locale.yaml`.

1. Remove `## ddev-generated` from the file. This will prevent DDEV from updating it.

### Change timezone

1. To change timezones, update the `timezone` line with the TZ identifier for your desired location.

    See [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

### Change locale

1. To update the language, update the `web_environment` line.

This contains up to 3 parts:

- Language code ().

- Territory code (). Separate from language with `_`.

A 3rd code-set value (separated with `.`) is optional.

For example: `LANG=en_AU.UTF-8`

- English language.

- Australian territory.

- `UTF-8` code-set.

## Components of the repository

- `config.locale.yaml`: the settings that are merging with the project's configuration.

- An [install.yaml](install.yaml) file that describes how to install the service or other component.

- A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected.

- [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository.

## Contributing

PRs are welcome, especially if they contain tests.

**Contributed and maintained by [@tyler36](https://github.com/tyler36)**