diff options
| l--------- | README.adoc | 1 | ||||
| -rw-r--r-- | README.md (renamed from README) | 55 | ||||
| l--------- | _doc/README.adoc | 1 | ||||
| l--------- | _doc/README.md | 1 | ||||
| -rw-r--r-- | _screenshots/trunks_attack_result.png | bin | 252107 -> 85257 bytes | |||
| -rw-r--r-- | _screenshots/trunks_example.png | bin | 154326 -> 52315 bytes |
6 files changed, 29 insertions, 29 deletions
diff --git a/README.adoc b/README.adoc deleted file mode 120000 index 100b938..0000000 --- a/README.adoc +++ /dev/null @@ -1 +0,0 @@ -README
\ No newline at end of file @@ -1,85 +1,86 @@ -= Trunks -:toc: -:sectanchors: -:sectlinks: +# Trunks Trunks is a Go library that provide HTTP service with web user interface to test HTTP and/or WebSocket endpoints and for load testing HTTP endpoints. For testing HTTP endpoints it use the -https://pkg.go.dev/github.com/shuLhan/share/lib/http[lib/http^] +[lib/http](https://pkg.go.dev/github.com/shuLhan/share/lib/http) package as the client, a wrapper for standard Go HTTP package. For testing WebSocket endpoints it use the -https://pkg.go.dev/github.com/shuLhan/share/lib/websocket[lib/websocket^] +[lib/websocket](https://pkg.go.dev/github.com/shuLhan/share/lib/websocket) package as the client. For the load testing we use -https://github.com/tsenart/vegeta[vegeta^] +[vegeta](https://github.com/tsenart/vegeta) as the backend. -https://pkg.go.dev/git.sr.ht/~shulhan/trunks[Go doc^]. +[Go documentation](https://pkg.go.dev/git.sr.ht/~shulhan/trunks) -== Usage +## Usage See the -https://git.sr.ht/~shulhan/trunks/tree/main/item/example/[example^] +[example](https://git.sr.ht/~shulhan/trunks/tree/main/item/example/) package on how to programmatically use and create service using this module, or, * clone this repository, * execute `make dev`, and -* open http://127.0.0.1:8217. +* open <http://127.0.0.1:8217>. -== Screenshots +## Screenshots The following screenshot display the main interface to Run or Attack the registered HTTP service, -image:https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_example.png[Main interface,640] + The following screenshot display the result of attack in two forms, vegeta metrics and vegeta histogram, -image:https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_attack_result.png[Attack result,640] + -== Web user interface (WUI) +## Web user interface (WUI) By default, the Trunks user interface can be viewed by opening in browser at -http://127.0.0.1:8217. +<http://127.0.0.1:8217>. One can change address through Environment's ListenAddress. -== File name format +## File name format Each attack result is saved in Environment's ResultsDir with the following file name format, - <Target.ID> "." <HttpTarget.ID> "." <DateTime> "." <Rate> "x" <Duration> "." <ResultsSuffix> +``` +<Target.ID> "." <HttpTarget.ID> "." <DateTime> "." <Rate> "x" <Duration> "." <ResultsSuffix> +``` The "DateTime" is in the following layout, - YearMonthDate "_" HourMinuteSeconds +``` +YearMonthDate "_" HourMinuteSeconds +``` The "ResultsSuffix" is the one that defined in Environment. -== Development +## Development -https://git.sr.ht/~shulhan/trunks[Repository^]:: Link to the source code. +[Repository](https://git.sr.ht/~shulhan/trunks):: Link to the source code. -https://lists.sr.ht/~shulhan/trunks[Mailing list^]:: Link to discussion and +[Mailing list](https://lists.sr.ht/~shulhan/trunks):: Link to discussion and where to send patches. -https://todo.sr.ht/~shulhan/trunks[Issues^]:: Link to report for bug or +[Issues](https://todo.sr.ht/~shulhan/trunks):: Link to report for bug or feature. -== Credits +## Credits -The Trunks icon and image is provided by https://www.spriters-resource.com/. +The Trunks icon and image is provided by <https://www.spriters-resource.com/>. -== License +## License Copyright (C) 2021 M. Shulhan <ms@kilabit.info> @@ -94,4 +95,4 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with -this program. If not, see <http://www.gnu.org/licenses/>. +this program. If not, see <https://www.gnu.org/licenses/>. diff --git a/_doc/README.adoc b/_doc/README.adoc deleted file mode 120000 index a7ab0b1..0000000 --- a/_doc/README.adoc +++ /dev/null @@ -1 +0,0 @@ -../README.adoc
\ No newline at end of file diff --git a/_doc/README.md b/_doc/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/_doc/README.md @@ -0,0 +1 @@ +../README.md
\ No newline at end of file diff --git a/_screenshots/trunks_attack_result.png b/_screenshots/trunks_attack_result.png Binary files differindex d463af6..8f64a96 100644 --- a/_screenshots/trunks_attack_result.png +++ b/_screenshots/trunks_attack_result.png diff --git a/_screenshots/trunks_example.png b/_screenshots/trunks_example.png Binary files differindex 3b7f660..705e040 100644 --- a/_screenshots/trunks_example.png +++ b/_screenshots/trunks_example.png |
