Add documentation on exit codes (#765)

Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
webrecorder · Feb 11, 2025 · 4b72b7c · 4b72b7c
1 parent fc56c2c
commit 4b72b7c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/docs/user-guide/exit-codes.md b/docs/docs/user-guide/exit-codes.md
@@ -0,0 +1,19 @@
+# Exit codes
+
+The crawler uses following exit codes to indicate crawl result.
+
+| Code | Name | Description |
+|--|--|--|
+| 0 | Success | Crawl completed normally |
+| 1 | GenericError | Unspecified error, check logs for more details |
+| 3 | OutOfSpace | Disk is already full |
+| 9 | Failed | Crawl failed unexpectedly, might be worth retrying |
+| 10 | BrowserCrashed | Browser used to fetch pages has crashed |
+| 11 | SignalInterrupted | Crawl stopped gracefully in response to SIGINT signal |
+| 12 | FailedLimit | Limit on amount of failed pages, configured with `--failOnFailedLimit`, has been reached |
+| 13 | SignalInterruptedForce | Crawl stopped forcefully in response to SIGTERM or repeated SIGINT signal |
+| 14 | SizeLimit | Limit on maximum WARC size, configured with `--sizeLimit`, has been reached |
+| 15 | TimeLimit | Limit on maximum crawl duration, configured with `--timeLimit`, has been reached |
+| 16 | DiskUtilization | Limit on maximum disk usage, configured with `--diskUtilization`, has been reached |
+| 17 | Fatal | A fatal (non-retryable) error occured |
+| 21 | ProxyError | Unable to establish connection with proxy |
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -51,6 +51,7 @@ nav:
   - User Guide:
     - user-guide/index.md
     - user-guide/outputs.md
+    - user-guide/exit-codes.md
     - user-guide/common-options.md
     - user-guide/crawl-scope.md
     - user-guide/yaml-config.md