-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,38 @@ | ||
# docker-nomnoml | ||
Dockerized Nomnoml by Nginx And NJS. | ||
# Docker Nomnoml | ||
|
||
> Dockerized Nomnoml by Nginx And NJS. | ||
Docker Nomnoml is a simple but elegant self-hosted UML Generator & UML Sharing solution. | ||
|
||
## usage | ||
|
||
```bash | ||
docker run --rm -it -p 8080:80 soulteary/nomnoml | ||
``` | ||
|
||
Base Nginx official docker image, for more information, refer to nginx container image [usage](https://hub.docker.com/_/nginx). | ||
|
||
## Components | ||
|
||
Does not include any software other than nginx and nomnoml, so that the resource usage is **very small** and the **performance is high enough**. | ||
|
||
### Nomnoml | ||
|
||
The sassy UML diagram renderer, created by [@Daniel Kallin](https://github.com/skanaar/) at [3 Jun 2014](https://github.com/skanaar/nomnoml/commit/211d19390d3615d86bced243c5878b8f4d535736). | ||
|
||
- [Nomnoml Docs](https://github.com/skanaar/nomnoml#web-application) | ||
- [Offical Website](https://www.nomnoml.com/) | ||
- [GitHub Repo](https://github.com/skanaar/nomnoml) | ||
|
||
### Nginx / NJS | ||
|
||
This Project use **Nginx script language (njs)** instead of Node as a server-side image generation solution. | ||
|
||
List some learning materials to help you step into the world of njs. Thanks to these open source authors and engineer of Nginx/F5, inc. | ||
|
||
- [soulteary/njs-learning-materials](https://github.com/soulteary/njs-learning-materials) | ||
|
||
## Benchmark | ||
|
||
TBD | ||
|