add optional path prefix.

This commit is contained in:
Miroslav Šedivý
2022-02-27 13:57:11 +01:00
parent 6f4a9429a8
commit 8e0623ee45
5 changed files with 35 additions and 17 deletions
+8
View File
@@ -11,3 +11,11 @@ All clients visit `https://neko-rooms/room-name/`. Once they logged in, they get
## Connection timeout ## Connection timeout
Neko room loads but you don't see the screen and it gives you `connection timeout` or `disconnected error`? [Validate](https://neko.m1k1o.net/#/getting-started/troubleshooting?id=validate-udp-ports-reachability) that your UDP ports are reachable. Neko room loads but you don't see the screen and it gives you `connection timeout` or `disconnected error`? [Validate](https://neko.m1k1o.net/#/getting-started/troubleshooting?id=validate-udp-ports-reachability) that your UDP ports are reachable.
## path prefix
Room names are by default put to root directory. If you want to have custom path prefix, you can specify it using evn variable:
```
NEKO_ROOMS_INSTANCE_PATH_PREFIX=/test/
```
+9 -2
View File
@@ -24,8 +24,9 @@ type Room struct {
MountsWhitelist []string MountsWhitelist []string
InstanceName string InstanceName string
InstanceUrl string InstanceUrl string
InstancePathPrefix string
TraefikDomain string TraefikDomain string
TraefikEntrypoint string TraefikEntrypoint string
@@ -95,6 +96,11 @@ func (Room) Init(cmd *cobra.Command) error {
return err return err
} }
cmd.PersistentFlags().String("instance.path_prefix", "", "path prefix that is added to a room path")
if err := viper.BindPFlag("instance.path_prefix", cmd.PersistentFlags().Lookup("instance.path_prefix")); err != nil {
return err
}
// Traefik // Traefik
cmd.PersistentFlags().String("traefik.domain", "", "traefik: domain on which will be container hosted (if empty or '*', match all; for neko-rooms as subdomain use '*.domain.tld')") cmd.PersistentFlags().String("traefik.domain", "", "traefik: domain on which will be container hosted (if empty or '*', match all; for neko-rooms as subdomain use '*.domain.tld')")
@@ -184,6 +190,7 @@ func (s *Room) Set() {
} }
s.InstanceUrl = viper.GetString("instance.url") s.InstanceUrl = viper.GetString("instance.url")
s.InstancePathPrefix = viper.GetString("instance.path_prefix")
s.TraefikDomain = viper.GetString("traefik.domain") s.TraefikDomain = viper.GetString("traefik.domain")
s.TraefikEntrypoint = viper.GetString("traefik.entrypoint") s.TraefikEntrypoint = viper.GetString("traefik.entrypoint")
+4 -3
View File
@@ -4,6 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"os" "os"
"path"
"github.com/go-chi/chi" "github.com/go-chi/chi"
"github.com/go-chi/chi/middleware" "github.com/go-chi/chi/middleware"
@@ -22,7 +23,7 @@ type HttpManagerCtx struct {
conf *config.Server conf *config.Server
} }
func New(ApiManager types.ApiManager, conf *config.Server) *HttpManagerCtx { func New(ApiManager types.ApiManager, pathPrefix string, conf *config.Server) *HttpManagerCtx {
logger := log.With().Str("module", "http").Logger() logger := log.With().Str("module", "http").Logger()
router := chi.NewRouter() router := chi.NewRouter()
@@ -54,8 +55,8 @@ func New(ApiManager types.ApiManager, conf *config.Server) *HttpManagerCtx {
} }
// add simple lobby room // add simple lobby room
router.Get("/{roomName}", ApiManager.RoomLobby) router.Get(path.Join("/", pathPrefix, "{roomName}"), ApiManager.RoomLobby)
router.Get("/{roomName}/", ApiManager.RoomLobby) router.Get(path.Join("/", pathPrefix, "{roomName}")+"/", ApiManager.RoomLobby)
router.NotFound(http.HandlerFunc(http.NotFound)) router.NotFound(http.HandlerFunc(http.NotFound))
+13 -12
View File
@@ -149,9 +149,10 @@ func (manager *RoomManagerCtx) Create(settings types.RoomSettings) (string, erro
// //
containerName := manager.config.InstanceName + "-" + roomName containerName := manager.config.InstanceName + "-" + roomName
pathPrefix := path.Join("/", manager.config.InstancePathPrefix, roomName)
// create traefik rule // create traefik rule
traefikRule := "PathPrefix(`/" + roomName + "`)" traefikRule := "PathPrefix(`" + pathPrefix + "`)"
if manager.config.TraefikDomain != "" && manager.config.TraefikDomain != "*" { if manager.config.TraefikDomain != "" && manager.config.TraefikDomain != "*" {
// match *.domain.tld as subdomain // match *.domain.tld as subdomain
if strings.HasPrefix(manager.config.TraefikDomain, "*.") { if strings.HasPrefix(manager.config.TraefikDomain, "*.") {
@@ -172,9 +173,9 @@ func (manager *RoomManagerCtx) Create(settings types.RoomSettings) (string, erro
"traefik.http.services." + containerName + "-frontend.loadbalancer.server.port": fmt.Sprintf("%d", frontendPort), "traefik.http.services." + containerName + "-frontend.loadbalancer.server.port": fmt.Sprintf("%d", frontendPort),
"traefik.http.routers." + containerName + ".entrypoints": manager.config.TraefikEntrypoint, "traefik.http.routers." + containerName + ".entrypoints": manager.config.TraefikEntrypoint,
"traefik.http.routers." + containerName + ".rule": traefikRule, "traefik.http.routers." + containerName + ".rule": traefikRule,
"traefik.http.middlewares." + containerName + "-rdr.redirectregex.regex": "/" + roomName + "$$", "traefik.http.middlewares." + containerName + "-rdr.redirectregex.regex": pathPrefix + "$$",
"traefik.http.middlewares." + containerName + "-rdr.redirectregex.replacement": "/" + roomName + "/", "traefik.http.middlewares." + containerName + "-rdr.redirectregex.replacement": pathPrefix + "/",
"traefik.http.middlewares." + containerName + "-prf.stripprefix.prefixes": "/" + roomName + "/", "traefik.http.middlewares." + containerName + "-prf.stripprefix.prefixes": pathPrefix + "/",
"traefik.http.routers." + containerName + ".middlewares": containerName + "-rdr," + containerName + "-prf", "traefik.http.routers." + containerName + ".middlewares": containerName + "-rdr," + containerName + "-prf",
} }
@@ -189,7 +190,6 @@ func (manager *RoomManagerCtx) Create(settings types.RoomSettings) (string, erro
// //
instanceUrl := manager.config.InstanceUrl instanceUrl := manager.config.InstanceUrl
instanceSuffix := roomName + "/"
if instanceUrl == "" { if instanceUrl == "" {
urlProto := "http" urlProto := "http"
if manager.config.TraefikCertresolver != "" { if manager.config.TraefikCertresolver != "" {
@@ -205,19 +205,20 @@ func (manager *RoomManagerCtx) Create(settings types.RoomSettings) (string, erro
if manager.config.TraefikDomain != "" && manager.config.TraefikDomain != "*" { if manager.config.TraefikDomain != "" && manager.config.TraefikDomain != "*" {
// match *.domain.tld as subdomain // match *.domain.tld as subdomain
if strings.HasPrefix(manager.config.TraefikDomain, "*.") { if strings.HasPrefix(manager.config.TraefikDomain, "*.") {
instanceUrl = urlProto + "://" + roomName + "." + strings.TrimPrefix(manager.config.TraefikDomain, "*.") + port + "/" instanceUrl = urlProto + "://" + roomName + "." + strings.TrimPrefix(manager.config.TraefikDomain, "*.") + port
instanceSuffix = "" pathPrefix = ""
} else { } else {
instanceUrl = urlProto + "://" + manager.config.TraefikDomain + port + "/" instanceUrl = urlProto + "://" + manager.config.TraefikDomain + port
} }
} else { } else {
// domain is not known // domain is not known
instanceUrl = urlProto + "://127.0.0.1" + port + "/" instanceUrl = urlProto + "://127.0.0.1" + port
} }
} else if !strings.HasSuffix(instanceUrl, "/") {
instanceUrl = instanceUrl + "/"
} }
// remove last slash
instanceUrl = strings.TrimSuffix(instanceUrl, "/")
var browserPolicyLabels *BrowserPolicyLabels var browserPolicyLabels *BrowserPolicyLabels
if settings.BrowserPolicy != nil { if settings.BrowserPolicy != nil {
browserPolicyLabels = &BrowserPolicyLabels{ browserPolicyLabels = &BrowserPolicyLabels{
@@ -228,7 +229,7 @@ func (manager *RoomManagerCtx) Create(settings types.RoomSettings) (string, erro
labels := manager.serializeLabels(RoomLabels{ labels := manager.serializeLabels(RoomLabels{
Name: roomName, Name: roomName,
URL: instanceUrl + instanceSuffix, URL: instanceUrl + pathPrefix + "/",
Epr: epr, Epr: epr,
NekoImage: settings.NekoImage, NekoImage: settings.NekoImage,
+1
View File
@@ -128,6 +128,7 @@ func (main *MainCtx) Start() {
main.httpManager = http.New( main.httpManager = http.New(
main.apiManager, main.apiManager,
main.Configs.Room.InstancePathPrefix,
main.Configs.Server, main.Configs.Server,
) )
main.httpManager.Start() main.httpManager.Start()