Metadata-Version: 2.4
Name: apexos-configurator
Version: 0.6.0
Summary: ApexOS Configurator - web-based editor for ApexOS configuration files
License-Expression: MIT
Project-URL: Repository, https://github.com/apexinfosysindia/configurator
Project-URL: Tracker, https://github.com/apexinfosysindia/configurator/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Editors
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pyotp
Requires-Dist: gitpython
Requires-Dist: legacy-cgi; python_version >= "3.13"
Dynamic: license-file

# ApexOS Configurator

Web-based file editor for ApexOS configuration files. Ships as the backend of
the ApexOS **File editor** add-on, but can run standalone against any
directory.

## Usage

```
pip install apexos-configurator
apexos-configurator /path/to/settings.conf
```

The optional settings file is JSON. Every setting can also be provided as an
environment variable using the `AC_` prefix (for example `AC_PORT=8099`).

Key settings:

| Key | Default | Purpose |
| --- | --- | --- |
| `LISTENIP` / `PORT` | `0.0.0.0` / `3218` | Bind address of the web UI |
| `BASEPATH` / `ENFORCE_BASEPATH` | unset / `false` | Directory to serve, optionally locked |
| `APEX_API` | `http://127.0.0.1:8123/api/` | ApexOS core HTTP API base URL |
| `APEX_WS_API` | unset | Websocket API URL, if different from `APEX_API` |
| `APEX_API_PASSWORD` | unset | Long-lived access token for the core API |
| `GIT` | `false` | Enable git integration (requires GitPython) |
| `USERNAME` / `PASSWORD` | unset | HTTP basic auth for the editor itself |

### Backward compatibility

Settings files and environments written for the pre-fork configurator keep
working: the legacy `HC_` environment prefix and the legacy key names
`HASS_API`, `HASS_WS_API` and `HASS_API_PASSWORD` are still read. When both a
legacy and a new name are present, the new name wins.

## License

MIT — see `LICENSE.txt`. This project is a rebranded fork of an upstream
MIT-licensed editor; the original license and copyright notice are preserved
unmodified.
