gopeed

README

English | 中文 | 日本語 | 正體中文

Introduction

Gopeed (full name Go Speed), a high-speed downloader developed by Golang + Flutter, supports (HTTP, BitTorrent, Magnet) protocol, and supports all platforms. In addition to basic download functions, Gopeed is also a highly customizable downloader that supports implementing more features through integration with APIs or installation and development of extensions.

Visit ✈ Official Website | 📖 Develop Docs

Install

Supported platforms

• windows
• macos
• linux
• android
• ios
• web
• docker

Download

Tips: If the macos open failed, please execute the xattr -d com.apple.quarantine /Applications/Gopeed.app command in the terminal

Command tool

use go install:

go install github.com/GopeedLab/gopeed/cmd/gopeed@latest

Docker

Start directly

docker run -d -p 9999:9999 -v /path/to/download:/root/Downloads liwei2633/gopeed

Using Docker Compose

docker-compose up -d

Access Gopeed

When the docker container is running, you can access the web page through http://localhost:9999.

Donate

If you like this project, please consider donating to support the development of this project, thank you!

Showcase

Development

This project is divided into two parts, the front end uses flutter, the back end uses Golang, and the two sides communicate through the http protocol. On the unix system, unix socket is used, and on the windows system, tcp protocol is used.

The front code is located in the ui/flutter directory.

Environment

1. Golang 1.19+
2. Flutter 3.10+

Clone

git clone git@github.com:GopeedLab/gopeed.git

Contributing

Please refer to CONTRIBUTING.md

Build

Desktop

First, you need to configure the environment according to the official Flutter desktop website documention, then you will need to ensure the cgo environment is set up accordingly. For detailed instructions on setting up the cgo environment, please refer to relevant resources available online.

command:

• windows

go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/windows/libgopeed.dll github.com/GopeedLab/gopeed/bind/desktop
cd ui/flutter
flutter build windows

• macos

go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/macos/Frameworks/libgopeed.dylib github.com/GopeedLab/gopeed/bind/desktop
cd ui/flutter
flutter build macos

• linux

go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/linux/bundle/lib/libgopeed.so github.com/GopeedLab/gopeed/bind/desktop
cd ui/flutter
flutter build linux

Mobile

Same as before, you also need to prepare the cgo environment, and then install gomobile:

go install golang.org/x/mobile/cmd/gomobile@latest
go get golang.org/x/mobile/bind
gomobile init

command:

• android

gomobile bind -tags nosqlite -ldflags="-w -s" -o ui/flutter/android/app/libs/libgopeed.aar -target=android -androidapi 19 -javapkg=com.gopeed github.com/GopeedLab/gopeed/bind/mobile
cd ui/flutter
flutter build apk

• ios

gomobile bind -tags nosqlite -ldflags="-w -s" -o ui/flutter/ios/Frameworks/Libgopeed.xcframework -target=ios github.com/GopeedLab/gopeed/bind/mobile
cd ui/flutter
flutter build ios --no-codesign

Web

command:

cd ui/flutter
flutter build web
cd ../../
rm -rf cmd/web/dist
cp -r ui/flutter/build/web cmd/web/dist
go build -tags nosqlite,web -ldflags="-s -w" -o bin/ github.com/GopeedLab/gopeed/cmd/web
go run cmd/web/main.go

Credits

Contributors

JetBrains

License

GPLv3