Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonaysoft/uptoc
A static file deployment tool that supports multiple platforms./ 一个支持多家云厂商的静态文件部署工具
https://github.com/bonaysoft/uptoc
cli cos deploying github-actions oss publishing qiniu s3 storage
Last synced: 1 day ago
JSON representation
A static file deployment tool that supports multiple platforms./ 一个支持多家云厂商的静态文件部署工具
- Host: GitHub
- URL: https://github.com/bonaysoft/uptoc
- Owner: bonaysoft
- License: mit
- Created: 2019-10-02T02:56:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T16:24:44.000Z (almost 2 years ago)
- Last Synced: 2025-01-18T01:07:25.973Z (6 days ago)
- Topics: cli, cos, deploying, github-actions, oss, publishing, qiniu, s3, storage
- Language: Go
- Homepage:
- Size: 130 KB
- Stars: 196
- Watchers: 7
- Forks: 32
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Uptoc
[](https://github.com/saltbo/uptoc/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/saltbo/uptoc)
[](https://app.codacy.com/manual/saltbo/uptoc?utm_source=github.com&utm_medium=referral&utm_content=saltbo/uptoc&utm_campaign=Badge_Grade_Dashboard)
[](https://github.com/saltbo/uptoc/releases)
[](https://github.com/saltbo/uptoc/blob/master/LICENSE)
English | [🇨🇳中文](https://saltbo.cn/uptoc)
## Run environment
- Mac
- Linux
- Windows
## Support Driver
- Aliyun OSS
- Tencent COS
- Qiniu Kodo
- Google Storage
- AWS S3
## Install the pre-compiled binary
**homebrew tap**:
```bash
brew install saltbo/bin/uptoc
```
**homebrew** (may not be the latest version):
```bash
brew install uptoc
```
**deb/rpm**:
Download the `.deb` or `.rpm` from the [releases page](https://github.com/saltbo/uptoc/releases) and
install with `dpkg -i` and `rpm -i` respectively.
**Shell script**:
```bash
curl -sSf https://uptoc.saltbo.cn/install.sh | sh
```
**manually**:
Download the pre-compiled binaries from the [releases page](https://github.com/saltbo/uptoc/releases) and
copy to the desired location.
## Usage
### Basic
```bash
uptoc --driver oss --region cn-beijing --access_key LTAI4FxxxxxxxBXmS3 --secret_key Vt1FZgxxxxxxxxxxxxKp380AI --bucket demo-bucket /opt/blog/public
```
And the access-key and access-secret support settings by the system environment
```bash
export UPTOC_UPLOADER_AK=LTAI4FxxxxxxxBXmS3
export UPTOC_UPLOADER_SK=Vt1FZgxxxxxxxxxxxxKp380AI
uptoc --driver oss --region cn-beijing --bucket blog-bucket /opt/blog/public
```
### Github Actions
See [action.yml](action.yml)
```yml
steps:
- name: Deploy
uses: saltbo/uptoc@master
with:
driver: oss
region: cn-zhangjiakou
bucket: saltbo-blog
exclude: .cache,test
dist: public
env:
UPTOC_UPLOADER_AK: ${{ secrets.UPTOC_UPLOADER_KEYID }}
UPTOC_UPLOADER_SK: ${{ secrets.UPTOC_UPLOADER_KEYSECRET }}
```
## Args Examples
| driver | bucket | region | region enum |
| ----- | --------- | ------ | ---- |
| oss | ut-uptoc | cn-hangzhou | [Regions](https://help.aliyun.com/document_detail/31837.html?spm=a2c4g.11186623.2.12.5fdb25b7xyEcuF#concept-zt4-cvy-5db) |
| cos | ut-uptoc-1255970412 | ap-shanghai | [Regions](https://cloud.tencent.com/document/product/436/6224) |
| qiniu | ut-uptoc | cn-east-1 | [Regions](https://developer.qiniu.com/kodo/manual/4088/s3-access-domainname) |
| google | ut-uptoc | auto | - |
| s3 | ut-uptoc | ap-northeast-1 | [Regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) |
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
## Contact us
- [Author Blog](https://saltbo.cn).
## Author
- [Saltbo](https://github.com/saltbo)
## License
- [MIT](https://github.com/saltbo/uptoc/blob/master/LICENSE)