https://github.com/shinolabs/harbor

Harbor is where the ships come to rest at the pink sea.
https://github.com/shinolabs/harbor

atproto bluesky image pinksea

Last synced: 13 days ago
JSON representation

Harbor is where the ships come to rest at the pink sea.

• Host: GitHub
• URL: https://github.com/shinolabs/harbor
• Owner: shinolabs
• License: mit
• Created: 2025-01-25T13:52:27.000Z (15 days ago)
• Default Branch: main
• Last Pushed: 2025-01-26T17:17:30.000Z (14 days ago)
• Last Synced: 2025-01-26T17:30:41.529Z (14 days ago)
• Topics: atproto, bluesky, image, pinksea
• Language: Elixir
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Harbor 🚢⚓

Harbor is a fast caching blob proxy service for the ATProto written in Elixir. It was written to replace `cdn.bsky.app` for [PinkSea](https://github.com/shinolabs/PinkSea)

## Usage

### Docker (recommended)

After cloning the repository, navigate to it and then create a folder called `cache`. After that run `docker compose up -d` to build and run the harbor image.

The service will be exposed via the port `4001` by default, you can change it by editing the `docker-compose.yml` file.

### Manual installation

After cloning the repo, navigate to the folder. Inside of it run `mix deps.get` to download the neccessary dependencies. Once it's done, run `mix run --no-halt` to run harbor. The service will start on port 4001.

To get a blob navigate to `http://localhost:4001//`. The blob will be fetched and cached inside of the `./cache` folder.

## License

Harbor is licensed under the MIT license.