You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-24Lines changed: 15 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,8 @@
5
5
-[Gemfast](#gemfast)
6
6
-[Why Gemfast](#why-gemfast)
7
7
-[Installing](#installing)
8
-
-[Debian Package](#debian-package)
9
-
-[Debian Package SSL](#debian-package-ssl)
10
8
-[Docker](#docker)
9
+
-[Prebuilt Binaries](#prebuilt-binaries)
11
10
-[Building From Source](#building-from-source)
12
11
-[Docs](#docs)
13
12
-[UI](#ui)
@@ -19,41 +18,23 @@ Gemfast was created for users who need to self-host their rubygems and want some
19
18
20
19
Gemfast has the following unique benefits:
21
20
22
-
* Two installation methods: [Debian Package](#debian-package) and [Docker Image](#docker)
21
+
* Two installation methods: [Docker Image](#docker) or precompiled binaries
23
22
* No need to install/upgrade/manage a version of Ruby on the server
24
23
* No external server dependencies like postgres, redis or memcached
25
-
* Automatic HTTPS via Caddy
26
24
* User login via GitHub oAuth
27
-
* No external server dependencies like postgres, redis or memcached
28
25
* Allow/Deny gems based on CVE severity or a regex list using the [ruby-advisory-db](https://github.com/rubysec/ruby-advisory-db)
29
-
*Go is generally faster and requires less memory then Ruby (still :heart: Ruby though)
26
+
*Performance benefits of Go
30
27
31
28
## Installing
32
29
33
-
Gemfast is currently distributed in two different ways, a `.deb` package and a `docker` image.
34
-
35
-
The `.deb` package includes a web server which proxies HTTPS traffic to Gemfast and is recommended when installing Gemfast on a virtual machine or bare-metal instance.
36
-
37
-
### Debian Package
38
-
39
-
To install the .deb package, download it from the latest GitHub release and install it with dpkg.
40
-
41
-
```bash
42
-
curl -L -O gemfast_<version>_amd64.deb
43
-
sudo dpkg -i ./gemfast_<version>_amd64.deb
44
-
sudo systemctl start gemfast.service
45
-
```
46
-
47
-
#### Debian Package SSL
48
-
49
-
The Gemfast `.deb` package includes Caddy Server which will automatically generate and manage a let's encrypt SSL certificate for your server. Caddy offers a few ways to generate a valid SSL certificate, see: https://caddyserver.com/docs/automatic-https#acme-challenges. If the let's encrypt challenge fails, the server will use a self-signed certificate.
30
+
Gemfast is currently distributed in two different ways, a `docker` image and precompiled binaries.
50
31
51
32
### Docker
52
33
53
34
When running Gemfast as a container, its important to mount the following directories:
54
35
55
-
* /etc/gemfast - The directory for the gemfast.hcl config file
56
36
* /var/gemfast - The directory for the Gemfast data including gems and database
37
+
* /etc/gemfast - The directory for the gemfast.hcl config file. It is possible to configure the config file path using `env GEMFAST_CONFIG_FILE=/path/to/my/file.hcl`
57
38
58
39
```bash
59
40
docker run -d --name gemfast-server \
@@ -63,6 +44,16 @@ docker run -d --name gemfast-server \
63
44
ghcr.io/gemfast/server:latest
64
45
```
65
46
47
+
### Prebuilt Binaries
48
+
49
+
Currently Prebuild binaries are available on each GitHub release for the following platforms.
50
+
51
+
- linux_amd64
52
+
- linux_arm64
53
+
- darwin_arm64
54
+
55
+
Simply download and extract the tarball to run the server.
56
+
66
57
### Building From Source
67
58
68
59
Gemfast uses Make to build binaries. To build and run a static binary:
0 commit comments