53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
# Transip client
|
|
|
|
A simple command line client for updating DNS records with the Transip API. It does
|
|
so by determining the current hosts (external) IP address and accordingly updates
|
|
the records DNS for the given domain names.
|
|
|
|
## Installation
|
|
|
|
Installation can be done through using uv:
|
|
|
|
```
|
|
$ uv sync --frozen --no-dev
|
|
```
|
|
|
|
Or through the provided Dockerfile:
|
|
|
|
```
|
|
$ docker image build --tag transip-client:0.7.0 .
|
|
```
|
|
|
|
Optional dependencies can be installed with:
|
|
|
|
```
|
|
$ uv sync --frozen --no-dev --extra sentry-enabled
|
|
```
|
|
|
|
For docker installations optional dependencies can be installed with:
|
|
|
|
```
|
|
$ docker image build \
|
|
--build-arg UV_ARGS="--extra sentry-enabled" \
|
|
--tag transip-client:0.7.0 .
|
|
```
|
|
|
|
## Usage
|
|
Use the help option to show all available options:
|
|
|
|
```
|
|
transip-update --help
|
|
```
|
|
|
|
|
|
## Configuration
|
|
|
|
The client can be configured with the following environment variables:
|
|
|
|
`LOGGING_CONFIG`: Specifies the path for the [logging configuration](https://docs.python.org/3.11/library/logging.html) to be used. Note that both `LOGGING_CONFIG_SRC` and `LOGGING_CONFIG_DST` can be used when building the docker image to achieve similar results.
|
|
|
|
`VERSION`: Application version. The client will try to retrieve this through git if it is not set.
|
|
|
|
`SENTRY_DSN`: Optionally used for specifying Sentry's DSN
|
|
|
|
`ENVIRONMENT`: Optionally used for specifying the environment in Sentry
|