From 8e9854287ed36acad3ed1e5f876274c80f6e63a7 Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 23 Nov 2024 21:54:22 -0800 Subject: [PATCH] Update README.md --- README.md | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 3e5edaf..7707fb3 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,36 @@ ![logo](https://raw.githubusercontent.com/managedkaos/cherokee/master/img/cherokee-logo.png) # Status + ![Build and Publish to GHCR](https://github.com/managedkaos/cherokee/actions/workflows/publish-image-to-ghcr.yml/badge.svg) # Notice and Licensing -The Managed Kaos Cherokee Project (hereafter referred to as "This project") is inspired by the [Cherokee Project](https://github.com/cherokee), specifically the [Cherokee Webserver](https://github.com/cherokee/webserver). - -This project is not endorsed or governed by the Cherokee Project. - -This project uses code from the Cherokee Project under the [GNU General Public License, Version 2](https://github.com/cherokee/webserver/blob/master/COPYING). -This project is licensed under the [MIT License](https://github.com/managedkaos/cherokee/blob/main/LICENSE). +The Managed Kaos Cherokee Project (hereafter referred to as "This project") is inspired by the [Cherokee Project](https://github.com/cherokee), specifically the [Cherokee Webserver](https://github.com/cherokee/webserver). -This project packages the code from the Cherokee Webserver into a container format. +This project: -This project does not modify the Cherokee Webserver code. +- is not endorsed or governed by the Cherokee Project. +- uses code from the Cherokee Project under the [GNU General Public License, Version 2](https://github.com/cherokee/webserver/blob/master/COPYING). +- is licensed under the [MIT License](https://github.com/managedkaos/cherokee/blob/main/LICENSE). +- packages the code from the Cherokee Webserver into a container format. +- does not modify the Cherokee Webserver code. Enjoy! :D # A container for the Cherokee web server To get started, pull the image: -### GitHub Packages (Preferred)[^1] ``` docker pull ghcr.io/managedkaos/cherokee:main ``` -### Docker Hub - -``` -docker pull managedkaos/cherokee -``` - After the pull, run the image: -### GitHub Packages (Preferred) ``` docker run --rm --name cherokee -d -p 80:80 -p 443:443 -p 9090:9090 ghcr.io/managedkaos/cherokee:main ``` -### Docker Hub - -``` -docker run --rm --name cherokee -d -p 80:80 -p 443:443 -p 9090:9090 managedkaos/cherokee -``` - Confirm operation by browsing to http://localhost. SSL support is built in! The container creates a self signed certificate at build time. Access the HTTPS version of the site by browsing to https://localhost @@ -70,14 +56,14 @@ docker exec -it cherokee cherokee-admin -b Use the output from the command to get the user name and the one time password. It should be similar to the following: ``` -Cherokee Web Server 1.2.104 (Oct 15 2022): Listening on port ALL:9090, TLS -disabled, IPv6 enabled, using epoll, 1048576 fds system limit, max. 524281 +Cherokee Web Server 1.2.104 (Nov 24 2024): Listening on port ALL:9090, TLS +disabled, IPv6 enabled, using poll, 1048576 fds system limit, max. 524281 connections, caching I/O, 4 threads, 131070 connections per thread, standard scheduling policy Login: User: admin - One-time Password: Yp7wb61uMA8Lb4qv + One-time Password: B4OUEMXoJYq9yAgZ Web Interface: URL: http://localhost:9090/