cast - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #golang #linux #docker #macos #java #awesome #cli #awesome-list #ios

cast

(★ 139)

Cast is an installer for any compatible Saltstack based distribution like SIFT or REMnux

파일 탐색기

최종 버전 다운로드 (.zip)

- - docs.yml
  - release.yml
  - semantic-lint.yml
  - semantic.yml
  - tests.yml
- renovate.json
- settings.json
- distro.md
- index.md
- migrate.md
- - cache.go
- - global.go
- - commands.go
  - constants.go
  - variables.go
  - version.go
- - config.go
- - verify.go
- - aliases.go
  - distro.go
  - github.go
  - github_test.go
  - http.go
  - local.go
  - manifest.go
  - types.go
- - git.go
- - client.go
- - installer.go
  - utils.go
- - http.go
  - release.go
  - release_test.go
- - constants.go
  - installer.go
  - installer_test.go
  - types.go
  - types_test.go
- - state.go
- - os.go
- - download.go
  - files.go
  - gpg.go
  - gpg_test.go
.gitignore
.golangci.yml
.goreleaser.yml
.releaserc.yml
CLAUDE.md
cosign.pub
Dockerfile
go.mod
go.sum
LICENSE
main.go
mkdocs.yml
pgp.pub
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ekristen/cast

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd cast

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker build -t cast .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 cast

빌드된 이미지를 실제 컨테이너로 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. Go

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Go Go 언어 컴파일러 및 도구 모음입니다.

go build ./...

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

go run .

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

✅ 빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Cast

![GitHub License](https://img.shields.io/github/license/ekristen/cast)
[![Known Vulnerabilities](https://snyk.io/test/github/ekristen/cast/badge.svg)](https://snyk.io/test/github/ekristen/cast)
[![Go Report Card](https://goreportcard.com/badge/github.com/ekristen/cast)](https://goreportcard.com/report/github.com/ekristen/cast)
![GitHub Release](https://img.shields.io/github/v/release/ekristen/cast?include_prereleases)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/ekristen/cast/total)

## Overview

Cast is a command line utility that abstracts away [SaltStack](https://saltproject.io) for compatible configurations.

It is the successor to the [SIFT CLI](https://github.com/teamdfir/sift-cli) but made in such a way that it is no longer specific to [SIFT](https://github.com/teamdfir/sift).

The goal is to deliver a simple command line utility to install custom distributions that are build with [saltstack](https://saltproject.io).

[![asciicast](https://asciinema.org/a/463178.svg)](https://asciinema.org/a/463178)

## Installation

Visit the releases page to download the appropriate file for your architecture. There are `.deb` files for installation
with `dpkg -i`, there are just vanilla binaries that you can download and put into `/usr/local/bin` if you'd like to as well.

## Usage

```bash
cast install <owner/repo|alias>
```

```bash
cast install teamdfir/sift-saltstack
```

### Existing Aliases

Cast comes with two built in aliases for existing support distributions, additional aliases will not be added, it's a
short term solution until the older install methods have fallen off.

**Note:** there are only two aliases currently supported, `sift` and `remnux` which are resolved to
`teamdfir/sift-saltstack` and `remnux/salt-states` respectively.

## Telemetry

As of 1.0.0, this tool uses [go-checkpoint](https://github.com/ekristen/go-checkpoint) which is a fork of Hashicorps checkpoint library. This allows
the tool to notify of new versions, security alerts and we can track metrics of which versions of the tool are in use. You can disable
with `export CHECKPOINT_DISABLE=1`.

## What is a Cast Distribution?

Simply put a cast distro is one published by the cast binary. The underlying technology used for installing the distro
is Saltstack.

To create a Cast distribution you need a `.cast.yml` file and need your repository to be a valid SaltStack configuration
that would work with a `state.apply` command.

### Existing Distributions

There are only two (2) version 1 cast distros out there and they are SIFT and REMnux and what makes them a v1 is the way
the release files are generated and signed and how the saltstack files are organized in the repository.

A version 2 cast distro is one like [cast-example-distro](https://github.com/ekristen/cast-example-distro) where the salt states start in the root of the project
and the release is generated by the `cast release`. The reason for moving the states to the root is for `git submodule`
usage for distros that extend another distro.

## Configuration

Cast is configured via the `.cast.yml` file in the root of the cast distro project. This configuration is required and
contains important information like what GitHub Repository should releases be published to, what the manifest file
contents should be.

Part of the configuration is the `manifest` definition that ultimately gets uploaded as a release asset. The manifest
dictates things like `base`, `modes`, and `supported operating systems`.

* `name` - the name of the distro
* `base` - (optional) this is the name of the base directory where the saltstack files exist in the project root
* `modes` - this is a way to define modes that the user can specify along with the default mode, if none is specified
* `supported_os` - this is a way to define what operating systems are supported

### For Developers

If your distro is called `alpha` then your `name` should be `alpha`, all base saltstack states should be based out of
the root of the project, however if all the states have to be in a subdirectory, then the `base_dir` must be set to the
name of that subdirectory.

### Aliases

Aliases are only for SIFT and REMnux and not intended for long term use. The aliases serve a more specific purpose for
supporting backwards compatibility for older versions of SIFT and REMnux that were not released as a **cast** distro
originally.

## Developers

Developing a distro for cast is very simple, this documentation will walk you through cast initialization.

### Saltstack

To make embedding a distro easier in another distro both for the community and for SANS builds purposes, the salt
states have now been moved to the root of the project. This allows for a repo to be submodule into another repo and
the `manifest.yml` dictates to the installer how things should be extracted and installed.

### Release

Requirements

* Tag must be created outside the tool and pushed to the remote
* Cosign private key and public key must be present in the repo

Creating a release has never been more simply. However, one thing is required, that you tag and push the tag to GitHub
prior to running the command.

```bash
git tag v1.0.0 && git push origin --tags
```

Then you simply run the release command from your local branch.

```bash
cast release
```