github-starred/frp

Fork 0

mirror of https://github.com/fatedier/frp.git synced 2026-05-15 08:05:49 -06:00

[GH-ISSUE #1366] [Document improvement request] Add installation guide in README.md #1084

New issue

Closed

opened 2026-05-05 12:41:44 -06:00 by gitea-mirror · 9 comments

gitea-mirror commented

2026-05-05 12:41:44 -06:00

Owner

Originally created by @recolic on GitHub (Aug 9, 2019).
Original GitHub issue: https://github.com/fatedier/frp/issues/1366

I'm trying to setup frp server on my vps.

It would be really helpful if frp/README.md contains a Installation section like other open source project does.

The installation guide should mention at least the following:

How to install go dependencies (in one command: go get ./.... Chinese user may have to break the fucking government wall)
How to build the package. Should I use Makefile or package.sh or go build?

by the way, PLEASE add #!/bin/bash into package.sh, else do not let package.sh executable.

How to install the package. Should I use Makefile or go install?
Additional information for distribution-specific installation guide. For example, frpc and frps are already available on ArchLinux AUR repo. It's better to let user know it.

Thanks for your awesome work.

Originally created by @recolic on GitHub (Aug 9, 2019). Original GitHub issue: https://github.com/fatedier/frp/issues/1366 I'm trying to setup frp server on my vps. It would be really helpful if frp/README.md contains a `Installation` section like other open source project does. The installation guide should mention at least the following: 1. How to install go dependencies (in one command: `go get ./...`. Chinese user may have to break the fucking government wall) 2. How to build the package. Should I use `Makefile` or `package.sh` or `go build`? > by the way, PLEASE add `#!/bin/bash` into package.sh, else do not let package.sh executable. 3. How to install the package. Should I use `Makefile` or `go install`? 4. Additional information for distribution-specific installation guide. For example, frpc and frps are already available on ArchLinux AUR repo. It's better to let user know it. Thanks for your awesome work.

gitea-mirror

2026-05-05 12:41:44 -06:00

closed this issue
added the
enhancement
label

gitea-mirror commented

2026-05-05 12:41:47 -06:00

Author

Owner

@fatedier commented on GitHub (Aug 9, 2019):

Yes, do you want to contribute to this?

@fatedier commented on GitHub (Aug 9, 2019): Yes, do you want to contribute to this?

gitea-mirror commented

2026-05-05 12:41:48 -06:00

Author

Owner

@recolic commented on GitHub (Aug 9, 2019):

I'll do it this weekend.

@recolic commented on GitHub (Aug 9, 2019): I'll do it this weekend.

gitea-mirror commented

2026-05-05 12:41:49 -06:00

Author

Owner

@recolic commented on GitHub (Aug 20, 2019):

This is just a note. never mind...

> not tested yet!
## non-root user
just git clone and make

## root user
mkdir -p $GOPATH/src/github.com/fatedier
git clone https://github.com/fatedier/frp $GOPATH/src/github.com/fatedier/frp
cd $GOPATH/src/github.com/fatedier/frp
make # `go get ./...` If fails.

@recolic commented on GitHub (Aug 20, 2019): This is just a note. never mind... ``` > not tested yet! ## non-root user just git clone and make ## root user mkdir -p $GOPATH/src/github.com/fatedier git clone https://github.com/fatedier/frp $GOPATH/src/github.com/fatedier/frp cd $GOPATH/src/github.com/fatedier/frp make # `go get ./...` If fails. ```

gitea-mirror commented

2026-05-05 12:41:49 -06:00

Author

Owner

@fatedier commented on GitHub (Aug 20, 2019):

GOPATH is deprecated.

Requried Go version >= go1.12

If the network is no problem to get third packages, just run GO111MODULE=on make, it will build with go mod.

Or using GOPROXY to download third packages such as GOPROXY=https://goproxy.io GO111MODULE=on make.

@fatedier commented on GitHub (Aug 20, 2019): `GOPATH` is deprecated. Requried Go version >= go1.12 If the network is no problem to get third packages, just run `GO111MODULE=on make`, it will build with go mod. Or using `GOPROXY` to download third packages such as `GOPROXY=https://goproxy.io GO111MODULE=on make`.

gitea-mirror commented

2026-05-05 12:41:50 -06:00

Author

Owner

@recolic commented on GitHub (Aug 20, 2019):

GOPATH is deprecated.

Requried Go version >= go1.12

If the network is no problem to get third packages, just run GO111MODULE=on make, it will build with go mod.

Or using GOPROXY to download third packages such as GOPROXY=https://goproxy.io GO111MODULE=on make.

I have successfully built the package under go1.10 with this method. Note that ubuntu 1804 only provides golang1.10.

@recolic commented on GitHub (Aug 20, 2019): > `GOPATH` is deprecated. > > Requried Go version >= go1.12 > > If the network is no problem to get third packages, just run `GO111MODULE=on make`, it will build with go mod. > > Or using `GOPROXY` to download third packages such as `GOPROXY=https://goproxy.io GO111MODULE=on make`. I have successfully built the package under go1.10 with [this method](https://github.com/recolic/frp#build-from-source). Note that ubuntu 1804 only provides golang1.10.

gitea-mirror commented

2026-05-05 12:41:51 -06:00

Author

Owner

@fatedier commented on GitHub (Aug 20, 2019):

It's deprecated and not maintained.

@fatedier commented on GitHub (Aug 20, 2019): It's deprecated and not maintained.

gitea-mirror commented

2026-05-05 12:41:51 -06:00

Author

Owner

@recolic commented on GitHub (Aug 20, 2019):

It's deprecated and not maintained.

I know. but I think it's better to provide some help... I'll mark go<1.12 as deprecated in the document.

@recolic commented on GitHub (Aug 20, 2019): > It's deprecated and not maintained. I know. but I think it's better to provide some help... I'll mark go<1.12 as deprecated in the document.

gitea-mirror commented

2026-05-05 12:41:52 -06:00

Author

Owner

@recolic commented on GitHub (Aug 30, 2019):

@fatedier Please check Pull request #1417

@recolic commented on GitHub (Aug 30, 2019): @fatedier Please check Pull request #1417

gitea-mirror commented

2026-05-05 12:41:52 -06:00

Author

Owner

@kaushikc44 commented on GitHub (Jan 13, 2020):