From 2a84c82f32cb60cd41adbefa98db733de490718b Mon Sep 17 00:00:00 2001 From: Lanre Adelowo Date: Sun, 2 Feb 2025 00:45:06 +0100 Subject: [PATCH] add malak http note --- README.md | 12 ++++++++---- go.mod | 3 +-- go.sum | 4 ---- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b8cc77f..ccb35e2 100644 --- a/README.md +++ b/README.md @@ -66,10 +66,6 @@ where `version` can be the version you want. The version can be in two formats: - semver version number e.g: `docker pull ghcr.io/ayinke-llc/malak:0.4.2` - commit hash e.g: `docker pull ghcr.io/ayinke-llc/malak:101a434d` -Plans are extremely important in Malak. Even though you are self hosting -and not taking payments, you can still limit certain features for users -on your instance. Every company/workspace must be have a plan. - At the very minimum, your configuration needs to look like this: > [!IMPORTANT] @@ -111,6 +107,14 @@ email: port: 9125 ``` +> [!IMPORTANT] +> The docker image runs the http server by default but if +> you are using the binary, you can run it with `malak http` + +Plans are extremely important in Malak. Even though you are self hosting +and not taking payments, you can still limit certain features for users +on your instance. Every company/workspace must be have a plan. + You can view a complete list of all available configuration here. #### Listing plans diff --git a/go.mod b/go.mod index 348a48a..8a02fcb 100644 --- a/go.mod +++ b/go.mod @@ -19,6 +19,7 @@ require ( github.com/ghodss/yaml v1.0.0 github.com/go-chi/chi/v5 v5.1.0 github.com/go-chi/render v1.0.3 + github.com/go-faker/faker/v4 v4.5.0 github.com/go-testfixtures/testfixtures/v3 v3.12.0 github.com/golang-migrate/migrate/v4 v4.17.1 github.com/google/uuid v1.6.0 @@ -92,7 +93,6 @@ require ( github.com/aws/smithy-go v1.21.0 // indirect github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect github.com/aymerick/douceur v0.2.0 // indirect - github.com/bxcodec/faker v2.0.1+incompatible // indirect github.com/catppuccin/go v0.2.0 // indirect github.com/cenkalti/backoff/v3 v3.2.2 // indirect github.com/cenkalti/backoff/v4 v4.3.0 // indirect @@ -119,7 +119,6 @@ require ( github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect github.com/felixge/httpsnoop v1.0.4 // indirect github.com/fsnotify/fsnotify v1.7.0 // indirect - github.com/go-faker/faker/v4 v4.5.0 // indirect github.com/go-faster/city v1.0.1 // indirect github.com/go-faster/errors v0.7.1 // indirect github.com/go-logr/logr v1.4.2 // indirect diff --git a/go.sum b/go.sum index a2e854d..f3a4c68 100644 --- a/go.sum +++ b/go.sum @@ -82,8 +82,6 @@ github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdb github.com/bsm/gomega v1.26.0/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0= github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA= github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0= -github.com/bxcodec/faker v2.0.1+incompatible h1:P0KUpUw5w6WJXwrPfv35oc91i4d8nf40Nwln+M/+faA= -github.com/bxcodec/faker v2.0.1+incompatible/go.mod h1:BNzfpVdTwnFJ6GtfYTcQu6l6rHShT+veBxNCnjCx5XM= github.com/catppuccin/go v0.2.0 h1:ktBeIrIP42b/8FGiScP9sgrWOss3lw0Z5SktRoithGA= github.com/catppuccin/go v0.2.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc= github.com/cenkalti/backoff/v3 v3.2.2 h1:cfUAAO3yvKMYKPrvhDuHSwQnhZNk/RMHKdZqKTxfm6M= @@ -558,8 +556,6 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= -golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224= -golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=