slawek/ok-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README for clarity and Docker usage instructions

Browse Source
This commit is contained in:
Sławek Koszewski
2026-03-27 11:43:14 +01:00
parent 5c323d07b5
commit b0b8a8994d
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,6 +1,8 @@
# Connectivity Test Server
A simple HTTP server designed for performing connectivity tests. May be run from command line or using a container.
A simple HTTP server for connectivity testing. It can be run from the command line or in a container. It relies only on Python's standard library, so it should work in any environment with Python installed.
It displays a simple HTML or plain-text page with the client's IP address and any detected `X-*` headers.
## Usage
@@ -19,15 +21,24 @@ Use the included `Dockerfile` to build and run the server in a Docker container:
```bash
docker build -t ok-server .
docker run -p 8000:8000 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
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Disclaimer
The `ok-server.py` file was generated using AI. The owner of the repository has reviewed and approved the generated content, however, it is important to note that the AI-generated code may contain errors or may not be optimized for all use cases. Users are encouraged to review and test the code before using it in production environments. The owner of the repository is not responsible for any issues that may arise from using the AI-generated code.
The `ok-server.py` file was 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.