🚀 Socket Launch Week 🚀 Day 3: Socket Acquires Coana.Learn More
Socket
Sign inDemoInstall
Socket

github.com/project-n-oss/sidekick

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/project-n-oss/sidekick

v1.4.0
Source
Go
Version published
Created
Source

release

projectn-sidekick.png

Sidekick

Sidekick is a sidecar proxy process that helps you integrate with the granica crunch platform.

What it does

Sidekick runs as a sidecar next to you application code and acts as a proxy to S3. If sidecar finds a crunched version of the file you are trying to query it will always return a 409. This garantees an error on the client side during the crunching of a file.

Getting started

Perequisites

  • go1.21

Running Sidekick

Local

You will need to create a config.yml file in the root of the project. You can use the following template:

App:
  CloudPlatform: AWS

These config values can also be set from ENV variable like so:

export SIDEKICK_APP_CLOUDPLATFORM=AWS

You can then run sidekick directly from the command line:

go run main.go serve

This will run sidekick localy on your machine on localhost:7075.

run the following command to learn more about the options:

go run main.go serve --help

Using Sidekick

Docker

You can pull the docker image from the containers page

You can then run the docker image with the following command:

docker run -p 7075:7075 --env SIDEKICK_APP_CLOUDPLATFORM=AWS <sidekick-image> serve 

Pre Built binaries

Sidekick binaries are hosted and released from GitHub. Please check our releases page. To download any release of our linux amd64 binary run:

wget https://github.com/project-n-oss/sidekick/releases/download/${release}/sidekick-linux-amd64.tar.gz

You can then run the binary directly:

SIDEKICK_APP_CLOUDPLATFORM=AWS ./sidekick serve

Integrations

Document on how to integrate sidekick with various services can be found in the integrations folder.

Contributing

Versioning

This repository uses release-please to create and manage release.

Commits

We follow conventional commits for our commits and PR titles. This allows us to use release-please to manage our releases.

The most important prefixes you should have in mind are:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

FAQs

Package last updated on 07 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts