65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# Connectivity Test Server
|
|
|
|
A simple HTTP server for connectivity testing. It can be run from the command line or in a container.
|
|
|
|
The Python version relies only on Python's standard library, so it should work in any environment with Python installed. The Node.js version also relies only on the standard library, so it should work in any environment with Node.js installed.
|
|
|
|
It displays a simple HTML or plain-text page with the client's IP address and any detected `X-*` headers.
|
|
|
|
## Disclaimer
|
|
|
|
The **ok-server** scripts were generated using AI under human supervision. The owner of the repository is not responsible for any issues that may arise from using the AI-generated code.
|
|
|
|
## Usage
|
|
|
|
### Command Line
|
|
|
|
To run the server from the command line:
|
|
|
|
```bash
|
|
python3 ok-server.py
|
|
python3 ok-server.py --look basic
|
|
python3 ok-server.py --bind 127.0.0.1 --port 8080 --look bootstrap
|
|
```
|
|
|
|
`--look` accepts `basic`, `nice`, or `bootstrap`.
|
|
You can override the look per request with the `look` query parameter, for example:
|
|
|
|
or
|
|
|
|
```bash
|
|
node ok-server.mjs
|
|
node ok-server.mjs --look basic
|
|
node ok-server.mjs --bind 127.0.0.1 --port 8080 --look bootstrap
|
|
```
|
|
|
|
Connect to the server using a web browser or a tool like `curl`:
|
|
|
|
```bash
|
|
curl -si "http://localhost:8000"
|
|
```
|
|
|
|
### Docker
|
|
|
|
Use the included `Dockerfile` to build and run the server in a Docker container:
|
|
|
|
```bash
|
|
docker build -t ok-server .
|
|
docker run --rm -d --name ok-server --cpus=1 --memory=256m -p 8000:8000 ok-server
|
|
```
|
|
|
|
### Container CLI on a Mac
|
|
|
|
```shell
|
|
container builder stop
|
|
container builder start -c 4 -m 1G
|
|
container build -t ok-server .
|
|
container run --rm -d --name ok-server -c 1 -m 256m -p 8000:8000 ok-server
|
|
```
|
|
|
|
This will start the server and expose it on port 8000.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|