https://github.com/b3b/icearrow-server

https://github.com/b3b/icearrow-server

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/b3b/icearrow-server
• Owner: b3b
• License: apache-2.0
• Created: 2024-09-08T15:05:27.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T16:34:47.000Z (4 months ago)
• Last Synced: 2024-10-03T11:35:53.607Z (4 months ago)
• Language: Go
• Size: 287 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IceArrow server

This repository represents the backend component of the [IceArrow](https://github.com/kkomelin/icearrow) app.

The IceArrow backend is built on top of:

- [Yopass](https://github.com/jhaals/yopass/tree/7e50bef6aacc5b401149914fd3472404f1b65e5c): A platform for the secure sharing of secrets, passwords, and files.

- [Walrus](https://docs.walrus.site/): A decentralized storage and data availability protocol optimized for large binary files.

## Getting Started

To run the project locally using Docker:

```bash

docker-compose up --build

```

### Accessing the application

- Storage API: Available at http://127.0.0.1/secret

- Walrus HTTP API: Available at http://127.0.0.1:31415

### API Usage Example

For examples of using the service and interacting with the Walrus API, refer to [walrus.ipynb](./notebooks/walrus.ipynb).

## Go Packages

- `walrus/walrus.go`: Implements `WalrusClient`, a client to interact with the Walrus HTTP API.

- `hippo/hippo.go`: Defines the `Hippo` struct, connecting with the Walrus storage via `WalrusClient`.

## Commands

- `icearrow-server`: Command to run the server.

- `walrus-client`: Wrapper for the Walrus package.