-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated unix-install.sh to pass URLs * Add documentation around new mirrior functionality * Add suggestion for autosync * Change QSG link text * Documentation feedback from JS on the PR * revert gosec version to fix false pos * disable arm64 for now, circle ci plan does not include it * Updated script to accept versions as just numeric (1.2.12) and automatically prepend the v (v1.2.12) needed for GH URLs * Clean up mirrors doc further, and implement changes suggested by JS again. * Fix tired typing typo Co-authored-by: jsirianni <joe.sirianni@observiq.com>
- Loading branch information
Showing
5 changed files
with
113 additions
and
39 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
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
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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Creating & Using Mirrors for Stanza Releases | ||
|
||
## Creating a Mirror | ||
Mirrors for Stanza can come in two forms: | ||
1. Hosted websites | ||
2. Local filesystem mirrors | ||
|
||
The only requirements for either are creating a directory layout that | ||
mirrors that of the GitHub releases, such as in the visualization below. | ||
It is suggested to use an automated synchronization process to manage | ||
keeping ths up to date, including rewriting the symlink for the latest | ||
to the highest version number. | ||
|
||
### Mirror Tree Visualization | ||
➜ stanza_mirror tree | ||
. | ||
├── download | ||
│ └── v1.2.12 | ||
│ ├── stanza-plugins.tar.gz | ||
│ ├── stanza-plugins.zip | ||
│ ├── stanza_darwin_amd64 | ||
│ ├── stanza_linux_amd64 | ||
│ ├── stanza_linux_arm64 | ||
│ ├── stanza_windows_amd64 | ||
│ ├── unix-install.sh | ||
│ ├── version.json | ||
│ └── windows-install.ps1 | ||
└── latest | ||
└── download | ||
├── stanza-plugins.tar.gz | ||
├── stanza-plugins.zip | ||
├── stanza_darwin_amd64 | ||
├── stanza_linux_amd64 | ||
├── stanza_linux_arm64 | ||
├── stanza_windows_amd64 | ||
├── unix-install.sh | ||
├── version.json | ||
└── windows-install.ps1 | ||
|
||
## Usage Syntax with the Install Script | ||
|
||
### Web URL | ||
```shell | ||
# Latest | ||
./unix-install -l http://dl.example.com/some/path | ||
# Specific Version 1.2.12 | ||
./unix-install -l http://dl.example.com/some/path -v 1.2.12 | ||
``` | ||
|
||
### File URL | ||
```shell | ||
./unix-install -l file:///Users/username/Downloads/stanza_local | ||
# Specific Version 1.2.12 | ||
./unix-install -l file:///Users/username/Downloads/stanza_local -v 1.2.12 | ||
``` | ||
|
||
## Further Information | ||
For further usage information, and other supported flags, please see the [Quick Start Guide](README.md) |
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
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