Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qdm12/caddy-ui
UI for the Caddy proxy server
https://github.com/qdm12/caddy-ui
Last synced: about 1 month ago
JSON representation
UI for the Caddy proxy server
- Host: GitHub
- URL: https://github.com/qdm12/caddy-ui
- Owner: qdm12
- License: mit
- Created: 2020-05-17T21:08:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T18:45:46.000Z (over 1 year ago)
- Last Synced: 2024-04-15T06:44:09.483Z (5 months ago)
- Language: TypeScript
- Size: 1.51 MB
- Stars: 58
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Caddy UI
*Caddy UI is a web frontend to interact with the Caddy server*
⚠️ This is under heavy development, expect some breaking changes or non functional images!
[](https://github.com/qdm12/caddy-ui/actions?query=workflow%3A%22Docker+build%22)
[](https://github.com/qdm12/caddy-ui-server/actions?query=workflow%3A%22Buildx+latest%22)
## Features
- Edit your Caddy server configuration in JSON or YML
- Works with Caddy v2.0.0 (you can use [this Docker image](https://github.com/qdm12/caddy-scratch))
- Compatible with `amd64`, `386`, `arm64` and `arm32v7` CPU architectures
- Runs without root
- Tiny Docker image of 11MB
- Docker image tags and sizes are available [here](https://hub.docker.com/r/qmcgaw/caddy-ui/tags)
## Setup
1. **If you run Caddy in a container**, make the admin api listen on `0.0.0.0:2019`and ensure Caddy's port `2019` is reachable somehow (i.e. with `-p 2019:2019/tcp`). You should also run caddy with `--resume` so that it uses its auto saved json configuration when it is restarted.
1. Run this container:
```sh
docker run -d -p 8000:8000/tcp -e CADDY_API_ENDPOINT="http://somehost:2019" qmcgaw/caddy-ui
```
You can also use docker-compose with `docker-compose up -d` and the following [docker-compose.yml](https://github.com/qdm12/caddy-ui/blob/master/docker-compose.yml):
```yml
version: "3.7"
services:
caddy:
image: qmcgaw/caddy-scratch
container_name: caddy
command: --resume
expose:
- 2019:2019/tcp
ports:
- 8080:8080/tcp
- 8443:8443/tcp
environment:
- TZ=
caddy-ui:
image: qmcgaw/caddy-ui
ports:
- 8000:8000/tcp
environment:
- CADDY_API_ENDPOINT=http://caddy:2019
```
1. Access the web app at [http://localhost:8000](http://localhost:8000).
### Environment variables
| Environment variable | Default | Description |
| --- | --- | --- |
| `CADDY_API_ENDPOINT` | `http://localhost:2019` | Caddy API endpoint address |
| `LOG_ENCODING` | `console` | Logging format, can be `json` or `console` |
| `LOG_LEVEL` | `info` | Logging level, can be `debug`, `info`, `warning`, `error` |
| `NODE_ID` | `-1` | Node ID for logger (`-1` to disable) |
| `LISTENING_PORT` | `8000` | Internal listening TCP port |
| `ROOT_URL` | `/` | URL path, used if behind a reverse proxy |
| `TZ` | `America/Montreal` | Timezone string |
| `CORS_WHITELIST` | | Comma separated list of hosts to whitelist for CORS, use only for development |
### Update
You can update the image with `docker pull qmcgaw/caddy-ui` or use one of [tags available](https://hub.docker.com/r/qmcgaw/caddy-ui/tags)
## Development
You might want to first refer to the [Caddy UI Server repository](https://github.com/qdm12/caddy-ui-server) which contains more architectural information and contains this repository as a Git submodule.
1. Setup your environment
Using VSCode and Docker
1. Install [Docker](https://docs.docker.com/install/)
- On Windows, share a drive with Docker Desktop and have the project on that partition
- On OSX, share your project directory with Docker Desktop
1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1. In Visual Studio Code, press on `F1` and select `Remote-Containers: Open Folder in Container...`
1. Your dev environment is ready to go!... and it's running in a container :+1:
Locally
Install [Nodejs](https://nodejs.org/en/download/) and [Docker](https://www.docker.com/products/docker-desktop), with eventually [yarn](https://classic.yarnpkg.com/en/docs/install/)
1. Commands available:
```sh
# Starts the development server with ts-node
yarn start
# Test the code
yarn test
# Lint the code
yarn lint
# Build the app for production
yarn build
# Build the Docker image
docker build -t qmcgaw/caddy-ui .
```
1. See [Contributing](.github/CONTRIBUTING.md) for more information on how to contribute to this repository.
## TODOs
- [ ] Check editor content on upload click
- [ ] Change public icons and logos
- [ ] Unit tests
- [ ] Refresh modal
## License
This repository is under an [MIT license](https://github.com/qdm12/caddy-ui/master/license) unless otherwise indicated