erugo — A secure, self hosted file sharing solution…

Pitch

Description

Comments

About this project

Erugo presents a reliable, self-hosted alternative to WeTransfer, designed for secure file sharing. With an easy-to-deploy binary, customizable options, and a modern user interface, it simplifies file management while ensuring that only authorized users can create shares. Ideal for those looking to maintain control over their data.

erugo is a secure, self-hosted alternative to WeTransfer, designed for users who value privacy and control. Built with Go and Vue.js, this application offers a seamless experience for file sharing, combining robust functionality with a modern, intuitive user interface, all within a single easy-to-deploy binary.

Key Features

Effortless Deployment: A single binary integrates both backend and frontend components for straightforward setup.
Human-Friendly Share Links: Generate easy-to-read URLs, such as https://yourdomains.com/shares/patient-haze-tiny-term, that are user-friendly and manageable.
Secure Access Control: Ensure only authorized users can create shares, while anyone with a link can download shared files.
Simple Data Management: Leverage SQLite for efficient storage of metadata, streamlining your file management process.
Flexible Configuration: Tailor storage paths and share size limits to meet specific needs.
Interactive Setup: Enjoy a user-friendly first-run configuration using Bubble Tea, making initial setup straightforward.
Modern Interface: Experience a clean, intuitive web UI that simplifies user interactions.
Open Source: Released under the MIT license, erugo welcomes modifications and adaptations, enabling white-labeling for personalized branding.

Getting Started with erugo

To begin sharing files securely:

Download the latest binary from the Releases page.
For Mac/Linux, grant execution permissions:
```
chmod +x erugo-darwin-arm64
```
Start erugo:
```
./erugo
```
Complete the interactive configuration to set up an admin account.
Access the web interface via http://localhost:9199.

Configuration Options

Customize erugo to suit your requirements through a configuration file. Here are key options you can adjust:

Option	Description	Default Value
`app_url`	Hosting URL for the application	`http://localhost:9199`
`base_storage_path`	Location for file storage	`storage`
`max_share_size`	Limit for maximum file size per share	`2G`
`bind_port`	Web server port	`9199`
`jwt_secret`	JWT authentication secret	`change_me`

A default config.json file will be created on first run to facilitate easy setup.

Utilizing erugo for File Sharing

Creating a Share

Log into the web interface.
Select the files to upload.
Share the generated link with intended recipients.

Downloading Files

Recipients can simply follow these steps:

Click on the share link provided.
Download the files from the web interface.

Customization Options

As an open-source project, erugo can be customized in various ways:

Alter the user interface to reflect your brand identity.
Change URL structures and authentication methods as per your requirements.
Enhance functionalities through direct code modifications.

Roadmap for Future Development

Upcoming features include:

UI-Based White-Labeling: Customize branding through the web interface.
Enhanced File Access: Direct file downloads without ZIP packaging.
Flexible Database Configuration: Options to configure database file locations.
Docker Support: Explore containerized deployment options for easier integration.

Community contributions are encouraged. Engage by submitting bug reports, feature requests, or participating in discussions to enhance this project.

For more insights and updates, visit the erugo GitHub repository.