{"id":37784847,"url":"https://github.com/zigbang/appstream","last_synced_at":"2026-01-16T15:11:20.897Z","repository":{"id":55032208,"uuid":"309853795","full_name":"zigbang/appstream","owner":"zigbang","description":null,"archived":false,"fork":false,"pushed_at":"2021-01-14T08:02:47.000Z","size":129,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-09-26T16:38:45.509Z","etag":null,"topics":["appstream","aws"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zigbang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-04T01:50:36.000Z","updated_at":"2022-04-19T06:36:10.000Z","dependencies_parsed_at":"2022-08-14T09:40:31.936Z","dependency_job_id":null,"html_url":"https://github.com/zigbang/appstream","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zigbang/appstream","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbang%2Fappstream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbang%2Fappstream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbang%2Fappstream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbang%2Fappstream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zigbang","download_url":"https://codeload.github.com/zigbang/appstream/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbang%2Fappstream/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appstream","aws"],"created_at":"2026-01-16T15:11:19.366Z","updated_at":"2026-01-16T15:11:20.881Z","avatar_url":"https://github.com/zigbang.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Automating AppStream deployments\n\n`AppStream`은 직방에서 AppStream 관리 및 배포를 위해 만든 툴 입니다. `AppStream`을 통해 원하는 AppStream의 생성 및 배포를 명령어 하나로 관리할 수 있습니다.\n\n## Why create such a thing?\n\n`AppStream`은 다음 2가지 철학을 근간으로 만들어 졌습니다.\n\n### Fully automated and Code-driven\n\nAppStream 이미지를 만들기 위해서는 사람의 손이 너무 많이 가는 문제가 있습니다. 이를 해결하기 위해서는 AppStream 이미지 및 스택을 만드는 프로세스가 모두 자동화가 되어야 하고 코드로 관리가 가능해야 합니다. `AppStream`을 이용할 경우 간단한 설정 파일 하나로 최신의 운영체제 및 원하는 소프트웨어들을 설치할 수 있고 이를 배포 할 수 있습니다.\n\n직방에서는 여러 형태의 AppStream을 제공해야 합니다. 예를 들어 특정 VPC 안에서 제한된 네트워크로 구동 되어야 하는 경우, 특정 램 이상의 환경으로 구동 되어야 하는 경우, 그래픽 가속이 필요한 경우 등 다양한 케이스들을 설정 파일들로 분리하여 지속적으로 배포하여 운영 하고 있습니다.\n\n### Up-to-date\n\n운영체제 및 소프트웨어는 지속적으로 발전하지만 한편으로는 항상 보안의 위협에 놓여 있습니다. `AppStream`은 성능, 기능 그리고 보안을 고려하여 최신 버전의 소프트웨어를 항상 기본값으로 적용합니다. 물론 특정 버전의 소프트웨어도 지정할 수 있습니다.\n\n직방에서는 `AppStream`을 이용하여 매일 혹은 필요 시 마다 AppStream을 배포하여 사용하고 있고 배포 시마다 최신 혹은 특정 버전의 운영체제 및 소프트웨어를 적용 합니다.\n\n\n## Getting Started\n\n### Prerequisites\n\n* [AWS Command Line Interface](https://aws.amazon.com/cli/)\n\n### Install `AppStream`\n\n```\n\u003e npm init\n\u003e npm install @zigbang/appstream --save-dev\n```\n\n혹은 그냥 global mode로 설치 해도 됩니다.\n\n```\n\u003e npm install -g @zigbang/appstream\n```\n\n### Create a config file\n아래과 같은 내용으로 `chrome.json` file 을 만듭니다.\n\n```\n{\n\t\"awsAccessKeyId\": \"\u003cYour AWS Access Key ID\u003e\",\n\t\"awsSecretAccessKey\": \"\u003cYour AWS Secret Access Key\u003e\",\n\t\"awsRegion\": \"\u003cYour AWS Region\u003e\",\n\t\"vpc\": \"\u003cYour AWS VPC ID\u003e\",\n\t\"availabilityZone\": \"\u003cYour AWS AvailabilityZone\u003e\",\n\t\"subnet\": \"\u003cYour AWS Subnet ID\u003e\",\n\t\"cidr\": \"x.x.x.x/x\",\n\t\"keyPair\": \"\u003cYour AWS EC2 Key Pair\u003e\",\n\t\"s3BucketUrl\": \"\u003cYour AWS S3 Bucket URL\u003e\",\n\t\"imageBuilderName\": \"zigbang-Chrome\",\n\t\"imageName\": \"zigbang-Chrome\",\n\t\"fleetName\": \"zigbang-Chrome\",\n\t\"stackName\": \"zigbang-chrome\",\n\t\"instanceType\": \"stream.standard.medium\",\n\t\"applications\": [\n\t\t{\n\t\t\t\"id\": \"Chrome\",\n\t\t\t\"packageName\": \"googlechrome\",\n\t\t\t\"path\": \"C:\\\\\\\"Program Files\\\"\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe\",\n\t\t\t\"displayName\": \"Chrome\"\n\t\t}\n\t]\n}\n```\n\n### Create an AppStream\n\n```\n\u003e npx appstream deploy ./chrome.json\n```\n또는\n\n```\n\u003e npx -p @zigbang/appstream appstream deploy ./chrome.json\n```\n\n### Delete an AppStream \n```\n\u003e npx appstream destroy ./chrome.json\n```\n\n## Configuration\n\n### Root\n\n| Variable | Required | Type | Default Value |Description |\n| ------------------ | -------- | -----| ------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| awsAccessKeyId | o | String | - | `AppStream`의 배포 과정에서 Active Directory에서 Image Builder 배포 시 필요한 AWS IAM Access Key ID |\n| awsSecretAccessKey | o | String | - | `AppStream`의 배포 과정에서 Active Directory에서 Image Builder 배포 시 필요한 AWS IAM Secret Access Key |\n| awsRegion | o | String | - | `AppStream`의 배포 과정에서 사용할 AWS Region [AWS Region Endpoints List](https://docs.aws.amazon.com/general/latest/gr/rande.html) 참고 |\n| vpc | o | String | - | `AppStream`의 배포 과정에서 사용하고 Fleet이 만들어지는 VPC의 ID |\n| availabilityZones | o | String | - | `AppStream`의 배포 과정에서 사용하고 fleet에서 사용될 availabilityZones |\n| subnet | o | String | - | `AppStream`의 배포 과정에서 사용하고 fleet에서 사용될 subnet의 ID |\n| cidr | o | String | - |`AWS Subnet` Ip prefix (ex. 172.16.1.0/24) |\n| keyPair | x | String | - |`AppStream`의 배포 과정에서 생성되는 EC2에 바인딩될 Key Pair의 이름 |\n| s3BucketUrl | o | String | - |`AppStream`이 배포 과정에서 사용할 파일을 임시 저장하는 S3 버킷 URL |\n| imageBuilderName | o | String | - | `AppStream Image Builder` 이름 \n| baseImage | x | String | AppStream-WinServer2019| `AppStream Image Builder`에서 생성할 Base Image, [AppStream Base Image List](https://docs.aws.amazon.com/appstream2/latest/developerguide/base-image-version-history.html) 참고\u003cbr\u003e `ex) AppStream-Graphics-G4dn-WinServer2019`로 값을 넣으면 해당 이미지 중 Release Date 중 가장 최신인 이미지를 가져옴(현재 기준: `AppStream-Graphics-G4dn-WinServer2019-07-16-2020`)\u003cbr\u003e |\n| imageName | o | String | - | `AppStream Image` 이름 |\n| fleetName | o | String | - | `AppStream Fleet` 이름 |\n| fleetSecurityGroupId | x | String | - | `AppStream Fleet` 에서 사용할 Security이며, 기존에 만들어진 SecurityGroup을 사용 시 추가 기존에 사용하는 SecurityGroup을 사용하지 않는다면 자동으로 생성 됨. |\n| fleetEnableDefaultInternetAccess? | x | Boolean | true | `AppStream Fleet`에서 Internet Access 허용 유무\u003cbr\u003eNAT Gateway를 사용할 경우 `false`로 설정 그리고 사용할 `subnet`이 Private Subnet인지 확인 |\n| fleetDesiredInstances | x | Number | 5 | `AppStream Fleet`에서 사용할 Instance의 개수 \u003cbr\u003e [Fleet Auto Scaling](https://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html) 참고 |\n| fleetType | x | String | ON_DEMAND | `AppStream Fleet`에서 Desktop까지 제공할 경우: `ALWAYS_ON`, Application만 제공할 경우: `ON_DEMAND` |\n| stacktName | o | String | - |`AppStream Stack` 이름 |\n| instanceType | o | String | - | `AppStream Image Builder` 및 `Fleet`에서 사용 하는 VM instance 유형 (ex. stream.standard.medium) [AppStream Instance Type List](https://aws.amazon.com/appstream2/pricing/#:~:text=Amazon%20AppStream%202.0%20supports%20three,and%20Streaming%20URL%20(API).) 참고 |\n| storageConnectorType | x | String | - |`AppStream Stack`에서 사용 하는 Storage Type `GOOGLE_DRIVE, ONE_DRIVE, HOMEFOLDERS` \u003cbr\u003e[AppStream Storage Connector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-connectortype) 참고|\n| connectorDomains | x | String[] | undefined |`AppStreamStack` 에서 Storage Connector 중 `GOOGLE_DRIVE` 혹은 `ONE_DRIVE` 사용 시 Access 가능한 Domain 지정 (ex. `zigbang.com`)\u003cbr\u003e `기본 값: undefined` |\n| tags | x | String[] | - | AWS 리소스에 추가 할 Tag |\n| applications | o | String[] | - | 설치할 소프트웨어의 목록 |\n| scripts | x | String[] | - |`AppStream Image Builder`에 추가적인 Powershell 설정이 필요한 경우 해당 옵션 사용 |\n\n### Tag \n\n| Variable | Required | Type | Description |\n| ----------- | -------- | ------ | ------------------------------------------------------------- |\n| key | o | String | `AWS Tags`에서 사용하는 Key \t\t\t \t\t\t\t\t\t |\n| value | o | String | `AWS Tags`에서 사용하는 Value \t\t\t \t\t\t\t\t |\n\n### Application\n\nImage Assistant CLI의 상세한 옵션은 다음 URL을 참고 하세요.\n\n* https://docs.aws.amazon.com/appstream2/latest/developerguide/programmatically-create-image.html\n\n| Variable | Required | Type | Description |\n| ----------- | -------- | ------ | ------------------------------------------------------------- |\n| id | o | String | Image Assistant CLI `add-application`의 `--name` |\n| packageName | o | String | [Chocolatey](https://chocolatey.org/) 패키지명 |\n| path | o | String | Image Assistant CLI `add-application`의 `--absolute-app-path` |\n| displayName | o | String | Image Assistant CLI `add-application`의 `--display-name` |\n\n\n\n### Scripts \n| Variable | Required | Type | Description |\n| ----------- | -------- | -------- | ---------------------------------------------------------------------- |\n| Scripts | x | String[] | `AppStream Image Builder`에 추가적인 Powershell 설정이 필요한 경우 해당 옵션 사용 |\n\n## How It Works Internally\n\n`AppStream`의 자동화는 Image Builder Windows에서의 Remote Management (WinRM)에 의존성이 높습니다. 이미 AWS에서 제공하는 많은 글들을 통해 Image Builder가 특정 전제 조건을 만족할 경우 원격으로 명령어를 실행하여 자동화하는 방법을 제공하고 있습니다.\n\n* [How to use SSM Run to perform programmatic actions on AppStream 2.0 image builders](https://aws.amazon.com/blogs/desktop-and-application-streaming/how-to-use-ssm-run-to-perform-programmatic-actions-on-appstream-2-0-image-builders/)\n\n전제 조건중 가장 중요한 부분은 Image Builder가 원격으로 명령을 받을 수 있는 환경이어야 한다는 점 입니다. 다만 대부분의 가이드는 Image Builder에 사람이 접속을 하여 활성화를 해줘야 한다는 점에서 사람의 개입이 있을 수 밖에 없어서 완전 자동화를 이룰 수 없는 한계점이 있습니다.\n\n이를 해결하기 위해서 `AppStream`은 사전에 Active Directory를 하나 생성합니다. 이 Active Directory의 역할은 Image Builder로 하여금 원격 명령을 받을 수 있는 정책을 내려주는 역할을 합니다. 그게 다입니다! 이를 통해 Image Builder는 도메인에 조인을 하고 GPO를 통해 원격 명령을 받을 수 있는 정책을 내려 받고 이후 Image Builder는 원격 명령을 내릴 수 있는 상태로 변경이 됩니다. 이 다음부터는 여러분들의 상상에 의해 자유롭게 Image Builder를 통해 원하는 이미지 생성을 하면 됩니다.\n\n`AppStream`이 구동되는 전체적인 workflow는 다음과 같습니다.\n\n![workflow](./docs/workflow.png)\n\n1. Active Directory를 생성\n * WinRM 설정을 내려주는 GPO를 생성\n2. Image Builder 생성 및 위에서 생성된 AD에 조인\n3. Image Builder에 필요한 소프트웨어 설치 및 설정\n4. Image 생성\n * 항상 최신 agent를 적용\n5. Fleet, stack 및 streaming URL 생성\n2. Clean up resources\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzigbang%2Fappstream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzigbang%2Fappstream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzigbang%2Fappstream/lists"}