Download and install Go.
🔔 Please note: version 1.18 or higher required
Run:
go run cmd/adhoc/main.go
To use Syncron, two important steps must be taken.
- Create configuration file.
- Important information about config:
-
Yaml based
-
Path: root of the project
-
Naming: syncron.yaml
-
A minimal syncron configuration file is as follows:
bucket: "<name of bucket to pull from>" s3: endpoint: "<endpoint>" region: "<region>" prefix: "<targeted keys starting path>" download_dir: "<path where files will be downloaded>"
-
- Important information about config:
- Proper credentials must be present on running machine at $HOME/.aws/credentials
The user is given several flags to pick which time frame to pull data from.
go run cmd/adhoc/main.go download [option] [--flag] [number]
Option | Description | Type | Default | Required? |
---|---|---|---|---|
sosreports |
Download sosreports files. | string |
sosreports |
Yes |
--flag | Description | Type | Default | Required? |
---|---|---|---|---|
days |
Download files from the past x days. | int |
2 |
No |
months |
Download files from the past x months. | int |
0 |
No |
years |
Download files from the past x years. | int |
0 |
No |
Syncron
is free and open-source software licensed under the Apache 2.0 License.