3 |
3 | 7 | Docs 8 | | 9 | Demo 10 | | 11 | Discord 12 |
13 | 14 | ## Quick Start 15 | 16 | [Configuration & Docker Compose](https://hay-kot.github.io/homebox/quick-start) 17 | 18 | ```bash 19 | # If using the rootless image, ensure data 20 | # folder has correct permissions 21 | mkdir -p /path/to/data/folder 22 | chown 65532:65532 -R /path/to/data/folder 23 | docker run -d \ 24 | --name homebox \ 25 | --restart unless-stopped \ 26 | --publish 3100:7745 \ 27 | --env TZ=Europe/Bucharest \ 28 | --volume /path/to/data/folder/:/data \ 29 | ghcr.io/hay-kot/homebox:latest 30 | # ghcr.io/hay-kot/homebox:latest-rootless 31 | ``` 32 | 33 | 34 | ## Contributing 35 | 36 | Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. 37 | 38 | If you are not a coder, you can still contribute financially. Financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development. 39 | 40 |
41 | ## Credits
42 |
43 | - Logo by [@lakotelman](https://github.com/lakotelman)
44 |
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | ## Supported Versions
4 |
5 | Since this software is still considered beta/WIP support is always only given for the latest version.
6 |
7 | ## Reporting a Vulnerability
8 |
9 | Please open a normal public issue if you have any security related concerns.
--------------------------------------------------------------------------------
/backend/.gitignore:
--------------------------------------------------------------------------------
1 |
2 | dist/
3 |
--------------------------------------------------------------------------------
/backend/.golangci.yml:
--------------------------------------------------------------------------------
1 | run:
2 | timeout: 10m
3 | skip-dirs:
4 | - internal/data/ent.*
5 | linters-settings:
6 | goconst:
7 | min-len: 5
8 | min-occurrences: 5
9 | exhaustive:
10 | default-signifies-exhaustive: true
11 | revive:
12 | ignore-generated-header: false
13 | severity: warning
14 | confidence: 3
15 | depguard:
16 | rules:
17 | main:
18 | deny:
19 | - pkg: io/util
20 | desc: |
21 | Deprecated: As of Go 1.16, the same functionality is now provided by
22 | package io or package os, and those implementations should be
23 | preferred in new code. See the specific function documentation for
24 | details.
25 | gocritic:
26 | enabled-checks:
27 | - ruleguard
28 | testifylint:
29 | enable-all: true
30 | tagalign:
31 | order:
32 | - json
33 | - schema
34 | - yaml
35 | - yml
36 | - toml
37 | - validate
38 | linters:
39 | disable-all: true
40 | enable:
41 | - asciicheck
42 | - bodyclose
43 | - depguard
44 | - dogsled
45 | - errcheck
46 | - errorlint
47 | - exhaustive
48 | - exportloopref
49 | - gochecknoinits
50 | - goconst
51 | - gocritic
52 | - gocyclo
53 | - gofmt
54 | - goprintffuncname
55 | - gosimple
56 | - govet
57 | - ineffassign
58 | - misspell
59 | - nakedret
60 | - revive
61 | - staticcheck
62 | - stylecheck
63 | - tagalign
64 | - testifylint
65 | - typecheck
66 | - typecheck
67 | - unconvert
68 | - unused
69 | - whitespace
70 | - zerologlint
71 | - sqlclosecheck
72 | issues:
73 | exclude-use-default: false
74 | fix: true
75 |
--------------------------------------------------------------------------------
/backend/.goreleaser.yaml:
--------------------------------------------------------------------------------
1 | # This is an example .goreleaser.yml file with some sensible defaults.
2 | # Make sure to check the documentation at https://goreleaser.com
3 | before:
4 | hooks:
5 | # you may remove this if you don't need go generate
6 | - go generate ./...
7 | builds:
8 | - main: ./app/api
9 | env:
10 | - CGO_ENABLED=0
11 | goos:
12 | - linux
13 | - windows
14 | - darwin
15 | goarch:
16 | - amd64
17 | - "386"
18 | - arm
19 | - arm64
20 | ignore:
21 | - goos: windows
22 | goarch: arm
23 | - goos: windows
24 | goarch: "386"
25 |
26 | archives:
27 | - format: tar.gz
28 | # this name template makes the OS and Arch compatible with the results of uname.
29 | name_template: >-
30 | {{ .ProjectName }}_
31 | {{- title .Os }}_
32 | {{- if eq .Arch "amd64" }}x86_64
33 | {{- else if eq .Arch "386" }}i386
34 | {{- else }}{{ .Arch }}{{ end }}
35 | {{- if .Arm }}v{{ .Arm }}{{ end }}
36 | # use zip for windows archives
37 | format_overrides:
38 | - goos: windows
39 | format: zip
40 | checksum:
41 | name_template: 'checksums.txt'
42 | snapshot:
43 | name_template: "{{ incpatch .Version }}-next"
44 | changelog:
45 | sort: asc
46 | filters:
47 | exclude:
48 | - '^docs:'
49 | - '^test:'
50 |
51 | # The lines beneath this are called `modelines`. See `:help modeline`
52 | # Feel free to remove those if you don't want/use them.
53 | # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
54 | # vim: set ts=2 sw=2 tw=0 fo=cnqoj
55 |
--------------------------------------------------------------------------------
/backend/app/api/app.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "github.com/hay-kot/homebox/backend/internal/core/services"
5 | "github.com/hay-kot/homebox/backend/internal/core/services/reporting/eventbus"
6 | "github.com/hay-kot/homebox/backend/internal/data/ent"
7 | "github.com/hay-kot/homebox/backend/internal/data/repo"
8 | "github.com/hay-kot/homebox/backend/internal/sys/config"
9 | "github.com/hay-kot/homebox/backend/pkgs/mailer"
10 | )
11 |
12 | type app struct {
13 | conf *config.Config
14 | mailer mailer.Mailer
15 | db *ent.Client
16 | repos *repo.AllRepos
17 | services *services.AllServices
18 | bus *eventbus.EventBus
19 | }
20 |
21 | func new(conf *config.Config) *app {
22 | s := &app{
23 | conf: conf,
24 | }
25 |
26 | s.mailer = mailer.Mailer{
27 | Host: s.conf.Mailer.Host,
28 | Port: s.conf.Mailer.Port,
29 | Username: s.conf.Mailer.Username,
30 | Password: s.conf.Mailer.Password,
31 | From: s.conf.Mailer.From,
32 | }
33 |
34 | return s
35 | }
36 |
--------------------------------------------------------------------------------
/backend/app/api/bgrunner.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "context"
5 | "time"
6 | )
7 |
8 | type BackgroundTask struct {
9 | name string
10 | Interval time.Duration
11 | Fn func(context.Context)
12 | }
13 |
14 | func (tsk *BackgroundTask) Name() string {
15 | return tsk.name
16 | }
17 |
18 | func NewTask(name string, interval time.Duration, fn func(context.Context)) *BackgroundTask {
19 | return &BackgroundTask{
20 | Interval: interval,
21 | Fn: fn,
22 | }
23 | }
24 |
25 | func (tsk *BackgroundTask) Start(ctx context.Context) error {
26 | timer := time.NewTimer(tsk.Interval)
27 |
28 | for {
29 | select {
30 | case <-ctx.Done():
31 | return nil
32 | case <-timer.C:
33 | timer.Reset(tsk.Interval)
34 | tsk.Fn(ctx)
35 | }
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/backend/app/api/handlers/debughandlers/debug.go:
--------------------------------------------------------------------------------
1 | // Package debughandlers provides handlers for debugging.
2 | package debughandlers
3 |
4 | import (
5 | "expvar"
6 | "net/http"
7 | "net/http/pprof"
8 | )
9 |
10 | func New(mux *http.ServeMux) {
11 | mux.HandleFunc("/debug/pprof", pprof.Index)
12 | mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
13 | mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
14 | mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
15 | mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
16 | mux.Handle("/debug/vars", expvar.Handler())
17 | }
18 |
--------------------------------------------------------------------------------
/backend/app/api/handlers/v1/assets/QRIcon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hay-kot/homebox/6fd8457e5ac1cbe652a8e59230ca6b3b2e97d45b/backend/app/api/handlers/v1/assets/QRIcon.png
--------------------------------------------------------------------------------
/backend/app/api/handlers/v1/partials.go:
--------------------------------------------------------------------------------
1 | package v1
2 |
3 | import (
4 | "net/http"
5 |
6 | "github.com/go-chi/chi/v5"
7 | "github.com/google/uuid"
8 | "github.com/hay-kot/homebox/backend/internal/sys/validate"
9 | )
10 |
11 | // routeID extracts the ID from the request URL. If the ID is not in a valid
12 | // format, an error is returned. If a error is returned, it can be directly returned
13 | // from the handler. the validate.ErrInvalidID error is known by the error middleware
14 | // and will be handled accordingly.
15 | //
16 | // Example: /api/v1/ac614db5-d8b8-4659-9b14-6e913a6eb18a -> uuid.UUID{ac614db5-d8b8-4659-9b14-6e913a6eb18a}
17 | func (ctrl *V1Controller) routeID(r *http.Request) (uuid.UUID, error) {
18 | return ctrl.routeUUID(r, "id")
19 | }
20 |
21 | func (ctrl *V1Controller) routeUUID(r *http.Request, key string) (uuid.UUID, error) {
22 | ID, err := uuid.Parse(chi.URLParam(r, key))
23 | if err != nil {
24 | return uuid.Nil, validate.NewRouteKeyError(key)
25 | }
26 | return ID, nil
27 | }
28 |
--------------------------------------------------------------------------------
/backend/app/api/handlers/v1/query_params.go:
--------------------------------------------------------------------------------
1 | package v1
2 |
3 | import (
4 | "net/url"
5 | "strconv"
6 |
7 | "github.com/google/uuid"
8 | )
9 |
10 | func queryUUIDList(params url.Values, key string) []uuid.UUID {
11 | var ids []uuid.UUID
12 | for _, id := range params[key] {
13 | uid, err := uuid.Parse(id)
14 | if err != nil {
15 | continue
16 | }
17 | ids = append(ids, uid)
18 | }
19 | return ids
20 | }
21 |
22 | func queryIntOrNegativeOne(s string) int {
23 | i, err := strconv.Atoi(s)
24 | if err != nil {
25 | return -1
26 | }
27 | return i
28 | }
29 |
30 | func queryBool(s string) bool {
31 | b, err := strconv.ParseBool(s)
32 | if err != nil {
33 | return false
34 | }
35 | return b
36 | }
37 |
--------------------------------------------------------------------------------
/backend/app/api/handlers/v1/v1_ctrl_qrcode.go:
--------------------------------------------------------------------------------
1 | package v1
2 |
3 | import (
4 | "bytes"
5 | "image/png"
6 | "io"
7 | "net/http"
8 | "net/url"
9 |
10 | "github.com/hay-kot/homebox/backend/internal/web/adapters"
11 | "github.com/hay-kot/httpkit/errchain"
12 | "github.com/yeqown/go-qrcode/v2"
13 | "github.com/yeqown/go-qrcode/writer/standard"
14 |
15 | _ "embed"
16 | )
17 |
18 | //go:embed assets/QRIcon.png
19 | var qrcodeLogo []byte
20 |
21 | // HandleGenerateQRCode godoc
22 | //
23 | // @Summary Create QR Code
24 | // @Tags Items
25 | // @Produce json
26 | // @Param data query string false "data to be encoded into qrcode"
27 | // @Success 200 {string} string "image/jpeg"
28 | // @Router /v1/qrcode [GET]
29 | // @Security Bearer
30 | func (ctrl *V1Controller) HandleGenerateQRCode() errchain.HandlerFunc {
31 | type query struct {
32 | // 4,296 characters is the maximum length of a QR code
33 | Data string `schema:"data" validate:"required,max=4296"`
34 | }
35 |
36 | return func(w http.ResponseWriter, r *http.Request) error {
37 | q, err := adapters.DecodeQuery[query](r)
38 | if err != nil {
39 | return err
40 | }
41 |
42 | image, err := png.Decode(bytes.NewReader(qrcodeLogo))
43 | if err != nil {
44 | panic(err)
45 | }
46 |
47 | decodedStr, err := url.QueryUnescape(q.Data)
48 | if err != nil {
49 | return err
50 | }
51 |
52 | qrc, err := qrcode.New(decodedStr)
53 | if err != nil {
54 | return err
55 | }
56 |
57 | toWriteCloser := struct {
58 | io.Writer
59 | io.Closer
60 | }{
61 | Writer: w,
62 | Closer: io.NopCloser(nil),
63 | }
64 |
65 | qrwriter := standard.NewWithWriter(toWriteCloser, standard.WithLogoImage(image))
66 |
67 | // Return the QR code as a jpeg image
68 | w.Header().Set("Content-Type", "image/jpeg")
69 | w.Header().Set("Content-Disposition", "attachment; filename=qrcode.jpg")
70 | return qrc.Save(qrwriter)
71 | }
72 | }
73 |
--------------------------------------------------------------------------------
/backend/app/api/handlers/v1/v1_ctrl_reporting.go:
--------------------------------------------------------------------------------
1 | package v1
2 |
3 | import (
4 | "net/http"
5 |
6 | "github.com/hay-kot/homebox/backend/internal/core/services"
7 | "github.com/hay-kot/httpkit/errchain"
8 | )
9 |
10 | // HandleBillOfMaterialsExport godoc
11 | //
12 | // @Summary Export Bill of Materials
13 | // @Tags Reporting
14 | // @Produce json
15 | // @Success 200 {string} string "text/csv"
16 | // @Router /v1/reporting/bill-of-materials [GET]
17 | // @Security Bearer
18 | func (ctrl *V1Controller) HandleBillOfMaterialsExport() errchain.HandlerFunc {
19 | return func(w http.ResponseWriter, r *http.Request) error {
20 | actor := services.UseUserCtx(r.Context())
21 |
22 | csv, err := ctrl.svc.Items.ExportBillOfMaterialsTSV(r.Context(), actor.GroupID)
23 | if err != nil {
24 | return err
25 | }
26 |
27 | w.Header().Set("Content-Type", "text/tsv")
28 | w.Header().Set("Content-Disposition", "attachment; filename=bill-of-materials.tsv")
29 | _, err = w.Write(csv)
30 | return err
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/backend/app/api/logger.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "os"
5 |
6 | "github.com/hay-kot/homebox/backend/internal/sys/config"
7 | "github.com/rs/zerolog"
8 | "github.com/rs/zerolog/log"
9 | )
10 |
11 | // setupLogger initializes the zerolog config
12 | // for the shared logger.
13 | func (a *app) setupLogger() {
14 | // Logger Init
15 | // zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
16 | if a.conf.Log.Format != config.LogFormatJSON {
17 | log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr}).With().Caller().Logger()
18 | }
19 |
20 | level, err := zerolog.ParseLevel(a.conf.Log.Level)
21 | if err == nil {
22 | zerolog.SetGlobalLevel(level)
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/backend/app/api/providers/doc.go:
--------------------------------------------------------------------------------
1 | // Package providers provides a authentication abstraction for the backend.
2 | package providers
3 |
--------------------------------------------------------------------------------
/backend/app/api/providers/extractors.go:
--------------------------------------------------------------------------------
1 | package providers
2 |
3 | import (
4 | "errors"
5 | "net/http"
6 |
7 | "github.com/hay-kot/homebox/backend/internal/sys/validate"
8 | "github.com/hay-kot/httpkit/server"
9 | "github.com/rs/zerolog/log"
10 | )
11 |
12 | type LoginForm struct {
13 | Username string `json:"username"`
14 | Password string `json:"password"`
15 | StayLoggedIn bool `json:"stayLoggedIn"`
16 | }
17 |
18 | func getLoginForm(r *http.Request) (LoginForm, error) {
19 | loginForm := LoginForm{}
20 |
21 | switch r.Header.Get("Content-Type") {
22 | case "application/x-www-form-urlencoded":
23 | err := r.ParseForm()
24 | if err != nil {
25 | return loginForm, errors.New("failed to parse form")
26 | }
27 |
28 | loginForm.Username = r.PostFormValue("username")
29 | loginForm.Password = r.PostFormValue("password")
30 | loginForm.StayLoggedIn = r.PostFormValue("stayLoggedIn") == "true"
31 | case "application/json":
32 | err := server.Decode(r, &loginForm)
33 | if err != nil {
34 | log.Err(err).Msg("failed to decode login form")
35 | return loginForm, errors.New("failed to decode login form")
36 | }
37 | default:
38 | return loginForm, errors.New("invalid content type")
39 | }
40 |
41 | if loginForm.Username == "" || loginForm.Password == "" {
42 | return loginForm, validate.NewFieldErrors(
43 | validate.FieldError{
44 | Field: "username",
45 | Error: "username or password is empty",
46 | },
47 | validate.FieldError{
48 | Field: "password",
49 | Error: "username or password is empty",
50 | },
51 | )
52 | }
53 |
54 | return loginForm, nil
55 | }
56 |
--------------------------------------------------------------------------------
/backend/app/api/providers/local.go:
--------------------------------------------------------------------------------
1 | package providers
2 |
3 | import (
4 | "net/http"
5 |
6 | "github.com/hay-kot/homebox/backend/internal/core/services"
7 | )
8 |
9 | type LocalProvider struct {
10 | service *services.UserService
11 | }
12 |
13 | func NewLocalProvider(service *services.UserService) *LocalProvider {
14 | return &LocalProvider{
15 | service: service,
16 | }
17 | }
18 |
19 | func (p *LocalProvider) Name() string {
20 | return "local"
21 | }
22 |
23 | func (p *LocalProvider) Authenticate(w http.ResponseWriter, r *http.Request) (services.UserAuthTokenDetail, error) {
24 | loginForm, err := getLoginForm(r)
25 | if err != nil {
26 | return services.UserAuthTokenDetail{}, err
27 | }
28 |
29 | return p.service.Login(r.Context(), loginForm.Username, loginForm.Password, loginForm.StayLoggedIn)
30 | }
31 |
--------------------------------------------------------------------------------
/backend/app/api/static/public/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hay-kot/homebox/6fd8457e5ac1cbe652a8e59230ca6b3b2e97d45b/backend/app/api/static/public/.gitkeep
--------------------------------------------------------------------------------
/backend/app/tools/migrations/main.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "context"
5 | "fmt"
6 | "log"
7 | "os"
8 |
9 | "github.com/hay-kot/homebox/backend/internal/data/ent/migrate"
10 |
11 | atlas "ariga.io/atlas/sql/migrate"
12 | _ "ariga.io/atlas/sql/sqlite"
13 | "entgo.io/ent/dialect"
14 | "entgo.io/ent/dialect/sql/schema"
15 | _ "github.com/mattn/go-sqlite3"
16 | )
17 |
18 | func main() {
19 | ctx := context.Background()
20 | // Create a local migration directory able to understand Atlas migration file format for replay.
21 | dir, err := atlas.NewLocalDir("internal/data/migrations/migrations")
22 | if err != nil {
23 | log.Fatalf("failed creating atlas migration directory: %v", err)
24 | }
25 | // Migrate diff options.
26 | opts := []schema.MigrateOption{
27 | schema.WithDir(dir), // provide migration directory
28 | schema.WithMigrationMode(schema.ModeReplay), // provide migration mode
29 | schema.WithDialect(dialect.SQLite), // Ent dialect to use
30 | schema.WithFormatter(atlas.DefaultFormatter),
31 | schema.WithDropIndex(true),
32 | schema.WithDropColumn(true),
33 | }
34 | if len(os.Args) != 2 {
35 | log.Fatalln("migration name is required. Use: 'go run -mod=mod ent/migrate/main.go
17 |
13 |
8 |
{{ text }}
6 |Password Strength: {{ message }}
4 | 14 |