https://github.com/slashtechno/ts-bot

https://github.com/slashtechno/ts-bot

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/slashtechno/ts-bot
• Owner: slashtechno
• License: mit
• Created: 2024-07-07T12:26:11.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-06T22:37:47.000Z (almost 2 years ago)
• Last Synced: 2025-08-22T15:53:06.533Z (10 months ago)
• Language: TypeScript
• Size: 188 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Mirror what?  

A Slack bot written in TypeScript for mirroring Docker images between Docker Hub and a private registry or exporting a Docker image to a tarball.  

![Screenshot of the bot being used to both clone and export library/hello-world](screenshot.png)

## Installation and setup  

## Node.js and npm  

1. Clone the repository.

2. Install the dependencies with `npm install`.

3. Build the project with `npm run build`.

4. Copy the `.env.example` file to `.env` and fill in the required values.

    * Reference `slack-app-manifest.yml` to setup the Slack app.  

## Docker  

1. Clone the repository.

2. Run with `docker compose up -d`.

    * `-d` runs the containers in the background.

    * `docker-compose.yml` is configured to use the `.env` file but can be edited for further customization.  

## Usage  

* Run the bot with `node .`.

* Clone an image to the private registry with `/clone-docker-image  `  

    * Example: `/clone-docker-image library/hello-world:latest`  

* Export an image to the export directory with `/clone-docker-image  `  

    * Example: `/export-docker-image library/hello-world:latest`