chore: update readme, change gh username

Author: phuongdnguyen

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2023 xxxibgdrgnmm nguyenduyphuong_t59@hus.edu.vn
+Copyright © 2023 nduyphuong nguyenduyphuong_t59@hus.edu.vn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,39 @@
 # Reverse registry
 
+This is Chainguard reverse registry that redirect to Chainguard's `cgr.dev/chainguard/*` public registry. The public, free tier of Chainguard Images only serves `latest` tag. This could be of inconvenience so we wrote this reverse registry to continously watching Chainguard registry for digest changes and extract the package version via SBOM. We then tag the image according with the packaged software version and serve via this reverse registry.
 
-This is a simple registry redirect service that redirect our.domain.com/* to cgr.dev/chainguard/*. It also run a background process to periodically hash image index to sha256 checksum and save to a local database (default in-mem sqlite is used. For production purpose, mysql is the recommended choice)
+By default, in-mem sqlite is used but MySQL is recommended for production setup.
+## Usage
 
-Deploying
+To be update
+
+How to run this locally/production.
+## How it works
+
+Just an example. Need to update this accordingly.
+
+```mermaid
+sequenceDiagram
+autonumber
+actor U as User
+participant RR as Reverse Registry
+participant DB as Local Digest Database
+participant CG as Chainguard Images
+U->>+RR: Pull command `nginx:1.0.0`
+RR->>+DB: Check if digest existed for `nginx:1.0.0`
+DB-->>-RR: Found digest for `nginx:1.0.0`
+RR-->>-U: Return digest if found
+
+loop Every x Minutes
+RR->>CG: Periodically checking `latest` tag for digest change
+RR->>DB: Save digest for this tag to local db
+end
+
+
+RR->>CG: Proxied every other APIs
+
+```
+
+## Deploy with Cloud Run
 
 [![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run)

app/app.go

@@ -5,12 +5,12 @@ import (
 	"time"
 
 	"github.com/gin-gonic/gin"
+	"github.com/nduyphuong/reverse-registry/config"
+	"github.com/nduyphuong/reverse-registry/handler"
+	"github.com/nduyphuong/reverse-registry/inject"
+	digestfetcher "github.com/nduyphuong/reverse-registry/services/digest-fetcher"
+	"github.com/nduyphuong/reverse-registry/utils"
 	"github.com/sirupsen/logrus"
-	"github.com/xxxibgdrgnmm/reverse-registry/config"
-	"github.com/xxxibgdrgnmm/reverse-registry/handler"
-	"github.com/xxxibgdrgnmm/reverse-registry/inject"
-	digestfetcher "github.com/xxxibgdrgnmm/reverse-registry/services/digest-fetcher"
-	"github.com/xxxibgdrgnmm/reverse-registry/utils"
 )
 
 func RunAPI(conf config.Config) error {

cmd/root.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 xxxibgdrgnmm nguyenduyphuong_t59@hus.edu.vn
+Copyright © 2023 nduyphuong nguyenduyphuong_t59@hus.edu.vn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -25,10 +25,10 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/nduyphuong/reverse-registry/config"
+	"github.com/nduyphuong/reverse-registry/constant"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-	"github.com/xxxibgdrgnmm/reverse-registry/config"
-	"github.com/xxxibgdrgnmm/reverse-registry/constant"
 )
 
 var cfgFile string

cmd/server.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 xxxibgdrgnmm <nguyenduyphuong_t59@hus.edu.vn>
+Copyright © 2023 nduyphuong <nguyenduyphuong_t59@hus.edu.vn>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -22,8 +22,8 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"github.com/nduyphuong/reverse-registry/app"
 	"github.com/spf13/cobra"
-	"github.com/xxxibgdrgnmm/reverse-registry/app"
 	"golang.org/x/sync/errgroup"
 )
 

driver/mysql_driver.go

@@ -3,7 +3,7 @@ package driver
 import (
 	"fmt"
 
-	"github.com/xxxibgdrgnmm/reverse-registry/model"
+	"github.com/nduyphuong/reverse-registry/model"
 	"gorm.io/driver/mysql"
 	"gorm.io/gorm"
 	"gorm.io/gorm/logger"

driver/sqlte_driver.go

@@ -1,7 +1,7 @@
 package driver
 
 import (
-	"github.com/xxxibgdrgnmm/reverse-registry/model"
+	"github.com/nduyphuong/reverse-registry/model"
 	"gorm.io/driver/sqlite"
 	"gorm.io/gorm"
 	"gorm.io/gorm/logger"

go.mod

@@ -1,4 +1,4 @@
-module github.com/xxxibgdrgnmm/reverse-registry
+module github.com/nduyphuong/reverse-registry
 
 go 1.20
 

handler/handler.go

@@ -9,10 +9,10 @@ import (
 
 	"github.com/docker/distribution/reference"
 	"github.com/gin-gonic/gin"
+	"github.com/nduyphuong/reverse-registry/repository"
+	containerregistry "github.com/nduyphuong/reverse-registry/services/container-registry"
+	"github.com/nduyphuong/reverse-registry/utils"
 	"github.com/sirupsen/logrus"
-	"github.com/xxxibgdrgnmm/reverse-registry/repository"
-	containerregistry "github.com/xxxibgdrgnmm/reverse-registry/services/container-registry"
-	"github.com/xxxibgdrgnmm/reverse-registry/utils"
 )
 
 type Interface interface {

inject/inject.go

@@ -3,10 +3,10 @@ package inject
 import (
 	"sync"
 
-	"github.com/xxxibgdrgnmm/reverse-registry/config"
-	"github.com/xxxibgdrgnmm/reverse-registry/driver"
-	"github.com/xxxibgdrgnmm/reverse-registry/repository"
-	containerregistry "github.com/xxxibgdrgnmm/reverse-registry/services/container-registry"
+	"github.com/nduyphuong/reverse-registry/config"
+	"github.com/nduyphuong/reverse-registry/driver"
+	"github.com/nduyphuong/reverse-registry/repository"
+	containerregistry "github.com/nduyphuong/reverse-registry/services/container-registry"
 )
 
 var imageStorage *repository.Storage