[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the
default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as
the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as
the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the
default for future PRs for this repo and language
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/matrix-org/dendrite/network/alerts).
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
docs/Gemfile.lock | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
index 509a8cbcf..5d79365f8 100644
--- a/docs/Gemfile.lock
+++ b/docs/Gemfile.lock
@@ -14,7 +14,7 @@ GEM
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
- commonmarker (0.23.6)
+ commonmarker (0.23.7)
concurrent-ruby (1.1.10)
dnsruby (1.61.9)
simpleidn (~> 0.1)
From 80738cc2a05941b91ad715bbf6831b636dbab08d Mon Sep 17 00:00:00 2001
From: Lukas <32310269+LukasLJL@users.noreply.github.com>
Date: Thu, 26 Jan 2023 16:25:17 +0100
Subject: [PATCH 2/4] Added Landing Page (#2885)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
I have added/copied a landing page like Synpase does.
Recently I have installed Dendrite and was wondering why it´s not
working. After some troubleshooting I figured out there is no landing
page like synpase has, so the Server was running just fine.
Hopefuly this PR can fix this problem and may help other users who run
into this issue.
I have not written any unit tests, because it´s just a simple landing
page with a redirect to a static site.
### Pull Request Checklist
* [x] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off below using a legally
identifiable
name](https://matrix-org.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately
Signed-off-by: `Lukas Huida`
Co-authored-by: Till Faelligen <2353100+S7evinK@users.noreply.github.com>
---
internal/httputil/paths.go | 1 +
setup/base/base.go | 28 +++++++++++++++
setup/base/base_test.go | 57 ++++++++++++++++++++++++++++++
setup/base/static/index.gotmpl | 63 ++++++++++++++++++++++++++++++++++
4 files changed, 149 insertions(+)
create mode 100644 setup/base/base_test.go
create mode 100644 setup/base/static/index.gotmpl
diff --git a/internal/httputil/paths.go b/internal/httputil/paths.go
index 12cf59eb4..62eff0415 100644
--- a/internal/httputil/paths.go
+++ b/internal/httputil/paths.go
@@ -19,6 +19,7 @@ const (
PublicFederationPathPrefix = "/_matrix/federation/"
PublicKeyPathPrefix = "/_matrix/key/"
PublicMediaPathPrefix = "/_matrix/media/"
+ PublicStaticPath = "/_matrix/static/"
PublicWellKnownPrefix = "/.well-known/matrix/"
InternalPathPrefix = "/api/"
DendriteAdminPathPrefix = "/_dendrite/"
diff --git a/setup/base/base.go b/setup/base/base.go
index de8f81517..6ea68119d 100644
--- a/setup/base/base.go
+++ b/setup/base/base.go
@@ -15,11 +15,14 @@
package base
import (
+ "bytes"
"context"
"crypto/tls"
"database/sql"
+ "embed"
"encoding/json"
"fmt"
+ "html/template"
"io"
"net"
"net/http"
@@ -65,6 +68,9 @@ import (
userapiinthttp "github.com/matrix-org/dendrite/userapi/inthttp"
)
+//go:embed static/*.gotmpl
+var staticContent embed.FS
+
// BaseDendrite is a base for creating new instances of dendrite. It parses
// command line flags and config, and exposes methods for creating various
// resources. All errors are handled by logging then exiting, so all methods
@@ -79,6 +85,7 @@ type BaseDendrite struct {
PublicKeyAPIMux *mux.Router
PublicMediaAPIMux *mux.Router
PublicWellKnownAPIMux *mux.Router
+ PublicStaticMux *mux.Router
InternalAPIMux *mux.Router
DendriteAdminMux *mux.Router
SynapseAdminMux *mux.Router
@@ -250,6 +257,7 @@ func NewBaseDendrite(cfg *config.Dendrite, componentName string, options ...Base
PublicKeyAPIMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.PublicKeyPathPrefix).Subrouter().UseEncodedPath(),
PublicMediaAPIMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.PublicMediaPathPrefix).Subrouter().UseEncodedPath(),
PublicWellKnownAPIMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.PublicWellKnownPrefix).Subrouter().UseEncodedPath(),
+ PublicStaticMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.PublicStaticPath).Subrouter().UseEncodedPath(),
InternalAPIMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.InternalPathPrefix).Subrouter().UseEncodedPath(),
DendriteAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.DendriteAdminPathPrefix).Subrouter().UseEncodedPath(),
SynapseAdminMux: mux.NewRouter().SkipClean(true).PathPrefix(httputil.SynapseAdminPathPrefix).Subrouter().UseEncodedPath(),
@@ -405,6 +413,7 @@ func (b *BaseDendrite) configureHTTPErrors() {
for _, router := range []*mux.Router{
b.PublicMediaAPIMux, b.DendriteAdminMux,
b.SynapseAdminMux, b.PublicWellKnownAPIMux,
+ b.PublicStaticMux,
} {
router.NotFoundHandler = notFoundCORSHandler
router.MethodNotAllowedHandler = notAllowedCORSHandler
@@ -478,6 +487,11 @@ func (b *BaseDendrite) SetupAndServeHTTP(
b.configureHTTPErrors()
+ //Redirect for Landing Page
+ externalRouter.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+ http.Redirect(w, r, httputil.PublicStaticPath, http.StatusFound)
+ })
+
internalRouter.PathPrefix(httputil.InternalPathPrefix).Handler(b.InternalAPIMux)
if b.Cfg.Global.Metrics.Enabled {
internalRouter.Handle("/metrics", httputil.WrapHandlerInBasicAuth(promhttp.Handler(), b.Cfg.Global.Metrics.BasicAuth))
@@ -485,6 +499,19 @@ func (b *BaseDendrite) SetupAndServeHTTP(
b.ConfigureAdminEndpoints()
+ // Parse and execute the landing page template
+ tmpl := template.Must(template.ParseFS(staticContent, "static/*.gotmpl"))
+ landingPage := &bytes.Buffer{}
+ if err := tmpl.ExecuteTemplate(landingPage, "index.gotmpl", map[string]string{
+ "Version": internal.VersionString(),
+ }); err != nil {
+ logrus.WithError(err).Fatal("failed to execute landing page template")
+ }
+
+ b.PublicStaticMux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+ _, _ = w.Write(landingPage.Bytes())
+ })
+
var clientHandler http.Handler
clientHandler = b.PublicClientAPIMux
if b.Cfg.Global.Sentry.Enabled {
@@ -510,6 +537,7 @@ func (b *BaseDendrite) SetupAndServeHTTP(
externalRouter.PathPrefix(httputil.SynapseAdminPathPrefix).Handler(b.SynapseAdminMux)
externalRouter.PathPrefix(httputil.PublicMediaPathPrefix).Handler(b.PublicMediaAPIMux)
externalRouter.PathPrefix(httputil.PublicWellKnownPrefix).Handler(b.PublicWellKnownAPIMux)
+ externalRouter.PathPrefix(httputil.PublicStaticPath).Handler(b.PublicStaticMux)
b.startupLock.Unlock()
if internalAddr != NoListener && internalAddr != externalAddr {
diff --git a/setup/base/base_test.go b/setup/base/base_test.go
new file mode 100644
index 000000000..61cb530a9
--- /dev/null
+++ b/setup/base/base_test.go
@@ -0,0 +1,57 @@
+package base_test
+
+import (
+ "bytes"
+ "embed"
+ "html/template"
+ "net/http"
+ "net/http/httptest"
+ "testing"
+ "time"
+
+ "github.com/matrix-org/dendrite/internal"
+ "github.com/matrix-org/dendrite/setup/config"
+ "github.com/matrix-org/dendrite/test/testrig"
+ "github.com/stretchr/testify/assert"
+)
+
+//go:embed static/*.gotmpl
+var staticContent embed.FS
+
+func TestLandingPage(t *testing.T) {
+ // generate the expected result
+ tmpl := template.Must(template.ParseFS(staticContent, "static/*.gotmpl"))
+ expectedRes := &bytes.Buffer{}
+ err := tmpl.ExecuteTemplate(expectedRes, "index.gotmpl", map[string]string{
+ "Version": internal.VersionString(),
+ })
+ assert.NoError(t, err)
+
+ b, _, _ := testrig.Base(nil)
+ defer b.Close()
+
+ // hack: create a server and close it immediately, just to get a random port assigned
+ s := httptest.NewServer(nil)
+ s.Close()
+
+ // start base with the listener and wait for it to be started
+ go b.SetupAndServeHTTP("", config.HTTPAddress(s.URL), nil, nil)
+ time.Sleep(time.Millisecond * 10)
+
+ // When hitting /, we should be redirected to /_matrix/static, which should contain the landing page
+ req, err := http.NewRequest(http.MethodGet, s.URL, nil)
+ assert.NoError(t, err)
+
+ // do the request
+ resp, err := s.Client().Do(req)
+ assert.NoError(t, err)
+ assert.Equal(t, http.StatusOK, resp.StatusCode)
+
+ // read the response
+ buf := &bytes.Buffer{}
+ _, err = buf.ReadFrom(resp.Body)
+ assert.NoError(t, err)
+
+ // Using .String() for user friendly output
+ assert.Equal(t, expectedRes.String(), buf.String(), "response mismatch")
+}
diff --git a/setup/base/static/index.gotmpl b/setup/base/static/index.gotmpl
new file mode 100644
index 000000000..b3c5576eb
--- /dev/null
+++ b/setup/base/static/index.gotmpl
@@ -0,0 +1,63 @@
+
+
+
+ Dendrite is running
+
+
+
+
+
+
+
It works! Dendrite {{ .Version }} is running
+
Your Dendrite server is listening on this port and is ready for messages.