Skip to content

Commit 21a53de

Browse files
committed
update README for 1.4.0 release
1 parent 9ff92fe commit 21a53de

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bridgr
1+
# Bridgr
22

33
> Bridging the air-gap for your artifacts
44
@@ -57,14 +57,15 @@ To only run one of the repository types, simply give that type after any configu
5757

5858
Additional command line options include:
5959

60-
| Option | Meaning |
61-
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
62-
| -v / --verbose | Verbose Output |
63-
| -n / --dry-run | Dry-run. Only do setup, don't fetch artifacts |
64-
| -c / --config | Specify an alternate configuration file |
65-
| --version | Print the version of Bridgr and exit. The output of stderr can be redirected to /dev/null to get just the version string. |
66-
| -H / --host | Run Bridgr in "hosting" mode. This mode does no downloading of artifacts, but makes Bridgr into a simple HTTP server. See `Hosting` for more detail |
67-
| -l / --listen | The listen address for Bridgr in hosting mode. This is only effective when coupled with the `-H` flag. Default is `:8080` |
60+
| Option | Meaning |
61+
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
62+
| -v / --verbose | Verbose Output |
63+
| -n / --dry-run | Dry-run. Only do setup, don't fetch artifacts |
64+
| -c / --config | Specify an alternate configuration file |
65+
| --version | Print the version of Bridgr and exit. The output of stderr can be redirected to /dev/null to get just the version string. |
66+
| -H / --host | Run Bridgr in "hosting" mode. This mode does no downloading of artifacts, but makes Bridgr into a simple HTTP server. See `Hosting` for more detail |
67+
| -l / --listen | The listen address for Bridgr in hosting mode. This is only effective when coupled with the `-H` flag. Default is `:8080` |
68+
| -x / --file-timeout | A go "duration" specifying an overall timeout for HTTP file downloads. Examples are `15s` (15 seconds), or `2h5m` (2 hours and 5 minutes). Default is `20s` |
6869

6970
### Artifacts requiring authentication
7071

@@ -121,7 +122,7 @@ You may also create a systemd service file and be able to control Bridgr as an O
121122

122123
## Development setup
123124

124-
Requires Go version 1.11 or higher.
125+
Requires Go version 1.13 or higher. Current Go version is specified in `go.mod`.
125126

126127
Bridgr uses Go modules available since GoLang 1.11 release. To do development on Bridgr, simply clone this repository to your preferred location
127128
and run `make`. This will download all dependencies using the controlled go modules configuration. You must have go properly installed and configured on your system first.
@@ -155,6 +156,9 @@ Potential library for creating iso9660 (ISO) files [https://github.com/kdomanski
155156

156157
## Release History
157158

159+
- 1.4.0
160+
- Complete rewrite of bridgr, to organize code internally for better testability and future work
161+
- Added `--file-timeout` flag to allow modifying the HTTP/s client overall timeout for downloading files
158162
- 1.3.0
159163
- Add authentication support
160164
- Update to Go version 1.13

0 commit comments

Comments
 (0)