From a9836aaea08000d08606050b0f874d0764f345bf Mon Sep 17 00:00:00 2001 From: Dmitry Verkhoturov Date: Wed, 27 Jul 2022 03:35:52 +0200 Subject: [PATCH] move static web files from rakyll/statik to go:embed There is no need for the rakyll/statik package starting with Go 1.16, which provides us with tools for embedding files without third-party libraries. --- .gitignore | 3 +- Dockerfile | 4 +- Dockerfile.artifacts | 9 +- backend/app/cmd/server.go | 5 + backend/app/cmd/web/index.html | 1 + backend/app/rest/api/rest.go | 39 ++- backend/go.mod | 1 - backend/go.sum | 2 - .../vendor/github.com/rakyll/statik/LICENSE | 202 --------------- .../vendor/github.com/rakyll/statik/fs/fs.go | 238 ------------------ .../github.com/rakyll/statik/fs/walk.go | 79 ------ backend/vendor/modules.txt | 3 - docker-init.sh | 30 ++- site/Dockerfile | 8 + site/src/docs/contributing/backend/index.md | 6 +- 15 files changed, 62 insertions(+), 568 deletions(-) create mode 100644 backend/app/cmd/web/index.html delete mode 100644 backend/vendor/github.com/rakyll/statik/LICENSE delete mode 100644 backend/vendor/github.com/rakyll/statik/fs/fs.go delete mode 100644 backend/vendor/github.com/rakyll/statik/fs/walk.go diff --git a/.gitignore b/.gitignore index 78dc4bfbde..04a841f110 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ target /logs/ /target/ /var/ -/web/ debug debug.test .vscode @@ -18,7 +17,7 @@ remark42 /bin/ /backend/var/ /backend/app/var/ -/backend/web/ +/backend/app/cmd/web/ /backend/*.html.tmpl compose-private-backend.yml compose-private-frontend.yml diff --git a/Dockerfile b/Dockerfile index 420c2cf244..04cdbcb49b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -55,6 +55,9 @@ ARG SKIP_BACKEND_TEST ARG BACKEND_TEST_TIMEOUT ADD backend /build/backend +# to embed the frontend files statically into Remark42 binary +COPY --from=build-frontend /srv/frontend/apps/remark42/public/ /build/backend/app/cmd/web/ +RUN find /build/backend/app/cmd/web/ -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; WORKDIR /build/backend # install gcc in order to be able to go test package with -race @@ -108,6 +111,5 @@ RUN ln -s /srv/remark42 /usr/bin/remark42 EXPOSE 8080 HEALTHCHECK --interval=30s --timeout=3s CMD curl --fail http://localhost:8080/ping || exit 1 - RUN chmod +x /srv/init.sh CMD ["/srv/remark42", "server"] diff --git a/Dockerfile.artifacts b/Dockerfile.artifacts index 53ff84235b..39321dd181 100644 --- a/Dockerfile.artifacts +++ b/Dockerfile.artifacts @@ -30,14 +30,9 @@ ADD backend /build/backend ADD README.md /build/ ADD LICENSE /build/ -COPY --from=build-frontend /srv/frontend/apps/remark42/public/ /build/backend/web/ +COPY --from=build-frontend /srv/frontend/apps/remark42/public/ /build/backend/app/cmd/web/ -RUN \ - export WEB_ROOT=/build/backend/web && \ - find . -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; && \ - statik --src=${WEB_ROOT} --dest=/build/backend/app/rest -p api -f && \ - ls -la /build/backend/app/rest/api/statik.go && \ - ls -la /build/backend/web/ +RUN find /build/backend/app/cmd/web/ -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; RUN \ version=$("/script/version.sh") && echo "version=${version}" && \ diff --git a/backend/app/cmd/server.go b/backend/app/cmd/server.go index 9d8345579c..5a6c73b7ce 100644 --- a/backend/app/cmd/server.go +++ b/backend/app/cmd/server.go @@ -2,6 +2,7 @@ package cmd import ( "context" + "embed" "fmt" "net/http" "net/url" @@ -41,6 +42,9 @@ import ( "github.com/umputun/remark42/backend/app/templates" ) +//go:embed web +var webFS embed.FS + // ServerCommand with command line flags and env type ServerCommand struct { Store StoreGroup `group:"store" namespace:"store" env-namespace:"STORE"` @@ -556,6 +560,7 @@ func (s *ServerCommand) newServerApp(ctx context.Context) (*serverApp, error) { Version: s.Revision, DataService: dataService, WebRoot: s.WebRoot, + WebFS: webFS, RemarkURL: s.RemarkURL, ImageProxy: imgProxy, CommentFormatter: commentFormatter, diff --git a/backend/app/cmd/web/index.html b/backend/app/cmd/web/index.html new file mode 100644 index 0000000000..0e34ff8f9d --- /dev/null +++ b/backend/app/cmd/web/index.html @@ -0,0 +1 @@ +This stub page would be replaced by the frontend statically built HTML during the Docker image build. diff --git a/backend/app/rest/api/rest.go b/backend/app/rest/api/rest.go index 820e95ac28..1b7ede5915 100644 --- a/backend/app/rest/api/rest.go +++ b/backend/app/rest/api/rest.go @@ -3,10 +3,13 @@ package api import ( "bytes" "context" + "embed" "encoding/json" "fmt" + "io/fs" "net/http" "net/mail" + "os" "regexp" "strings" "sync" @@ -23,7 +26,6 @@ import ( log "github.com/go-pkgz/lgr" R "github.com/go-pkgz/rest" "github.com/go-pkgz/rest/logger" - "github.com/rakyll/statik/fs" "github.com/umputun/remark42/backend/app/notify" "github.com/umputun/remark42/backend/app/rest" @@ -49,6 +51,7 @@ type Rest struct { AnonVote bool WebRoot string + WebFS embed.FS RemarkURL string ReadOnlyAge int SharedSecret string @@ -351,8 +354,8 @@ func (s *Rest) routes() chi.Router { rroot.Post("/email/unsubscribe.html", s.privRest.emailUnsubscribeCtrl) }) - // file server for static content from /web - addFileServer(router, "/web", http.Dir(s.WebRoot), s.Version) + // file server for static content from s.WebRoot on path /web + addFileServer(router, s.WebFS, s.WebRoot, s.Version) return router } @@ -463,34 +466,28 @@ func (s *Rest) configCtrl(w http.ResponseWriter, r *http.Request) { render.JSON(w, r, cnf) } -// serves static files from /web or embedded by statik -func addFileServer(r chi.Router, path string, root http.FileSystem, version string) { +// serves static files from the webRoot directory or files embedded into the compiled binary if that directory is absent +func addFileServer(r chi.Router, embedFS embed.FS, webRoot, version string) { var webFS http.Handler - statikFS, err := fs.New() - if err != nil { - log.Printf("[DEBUG] no embedded assets loaded, %s", err) - log.Printf("[INFO] run file server for %s, path %s", root, path) - webFS = http.FileServer(root) + if _, err := os.Stat(webRoot); err == nil { + log.Printf("[INFO] run file server from %s from the disk", webRoot) + webFS = http.FileServer(http.Dir(webRoot)) } else { - log.Printf("[INFO] run file server for %s, embedded", root) - webFS = http.FileServer(statikFS) + log.Printf("[INFO] run file server, embedded") + var contentFS, _ = fs.Sub(embedFS, "web") + webFS = http.FileServer(http.FS(contentFS)) } - origPath := path - webFS = http.StripPrefix(path, webFS) - if path != "/" && path[len(path)-1] != '/' { - r.Get(path, http.RedirectHandler(path+"/", http.StatusMovedPermanently).ServeHTTP) - path += "/" - } - path += "*" + webFS = http.StripPrefix("/web", webFS) + r.Get("/web", http.RedirectHandler("/web/", http.StatusMovedPermanently).ServeHTTP) r.With(tollbooth_chi.LimitHandler(tollbooth.NewLimiter(20, nil)), middleware.Timeout(10*time.Second), cacheControl(time.Hour, version), - ).Get(path, func(w http.ResponseWriter, r *http.Request) { + ).Get("/web/*", func(w http.ResponseWriter, r *http.Request) { // don't show dirs, just serve files - if strings.HasSuffix(r.URL.Path, "/") && len(r.URL.Path) > 1 && r.URL.Path != (origPath+"/") { + if strings.HasSuffix(r.URL.Path, "/") && len(r.URL.Path) > 1 && r.URL.Path != ("/web/") { http.NotFound(w, r) return } diff --git a/backend/go.mod b/backend/go.mod index 4ee533a5ef..390e0a13ea 100644 --- a/backend/go.mod +++ b/backend/go.mod @@ -26,7 +26,6 @@ require ( github.com/jessevdk/go-flags v1.5.0 github.com/kyokomi/emoji/v2 v2.2.9 github.com/microcosm-cc/bluemonday v1.0.19 - github.com/rakyll/statik v0.1.7 github.com/rs/xid v1.4.0 github.com/russross/blackfriday/v2 v2.1.0 github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e diff --git a/backend/go.sum b/backend/go.sum index f315e0f520..e354915524 100644 --- a/backend/go.sum +++ b/backend/go.sum @@ -316,8 +316,6 @@ github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= -github.com/rakyll/statik v0.1.7 h1:OF3QCZUuyPxuGEP7B4ypUa7sB/iHtqOTDYZXGM8KOdQ= -github.com/rakyll/statik v0.1.7/go.mod h1:AlZONWzMtEnMs7W4e/1LURLiI49pIMmp6V9Unghqrcc= github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/rs/xid v1.4.0 h1:qd7wPTDkN6KQx2VmMBLrpHkiyQwgFXRnkOLacUiaSNY= diff --git a/backend/vendor/github.com/rakyll/statik/LICENSE b/backend/vendor/github.com/rakyll/statik/LICENSE deleted file mode 100644 index a4c5efd822..0000000000 --- a/backend/vendor/github.com/rakyll/statik/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2014 Google Inc. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/backend/vendor/github.com/rakyll/statik/fs/fs.go b/backend/vendor/github.com/rakyll/statik/fs/fs.go deleted file mode 100644 index 5a5b46f2f4..0000000000 --- a/backend/vendor/github.com/rakyll/statik/fs/fs.go +++ /dev/null @@ -1,238 +0,0 @@ -// Copyright 2014 Google Inc. All Rights Reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Package fs contains an HTTP file system that works with zip contents. -package fs - -import ( - "archive/zip" - "bytes" - "errors" - "fmt" - "io" - "io/ioutil" - "net/http" - "os" - "path" - "path/filepath" - "sort" - "strings" - "time" -) - -var zipData = map[string]string{} - -// file holds unzipped read-only file contents and file metadata. -type file struct { - os.FileInfo - data []byte - fs *statikFS -} - -type statikFS struct { - files map[string]file - dirs map[string][]string -} - -const defaultNamespace = "default" - -// IsDefaultNamespace returns true if the assetNamespace is -// the default one -func IsDefaultNamespace(assetNamespace string) bool { - return assetNamespace == defaultNamespace -} - -// Register registers zip contents data, later used to initialize -// the statik file system. -func Register(data string) { - RegisterWithNamespace(defaultNamespace, data) -} - -// RegisterWithNamespace registers zip contents data and set asset namespace, -// later used to initialize the statik file system. -func RegisterWithNamespace(assetNamespace string, data string) { - zipData[assetNamespace] = data -} - -// New creates a new file system with the default registered zip contents data. -// It unzips all files and stores them in an in-memory map. -func New() (http.FileSystem, error) { - return NewWithNamespace(defaultNamespace) -} - -// NewWithNamespace creates a new file system with the registered zip contents data. -// It unzips all files and stores them in an in-memory map. -func NewWithNamespace(assetNamespace string) (http.FileSystem, error) { - asset, ok := zipData[assetNamespace] - if !ok { - return nil, errors.New("statik/fs: no zip data registered") - } - zipReader, err := zip.NewReader(strings.NewReader(asset), int64(len(asset))) - if err != nil { - return nil, err - } - files := make(map[string]file, len(zipReader.File)) - dirs := make(map[string][]string) - fs := &statikFS{files: files, dirs: dirs} - for _, zipFile := range zipReader.File { - fi := zipFile.FileInfo() - f := file{FileInfo: fi, fs: fs} - f.data, err = unzip(zipFile) - if err != nil { - return nil, fmt.Errorf("statik/fs: error unzipping file %q: %s", zipFile.Name, err) - } - files["/"+zipFile.Name] = f - } - for fn := range files { - // go up directories recursively in order to care deep directory - for dn := path.Dir(fn); dn != fn; { - if _, ok := files[dn]; !ok { - files[dn] = file{FileInfo: dirInfo{dn}, fs: fs} - } else { - break - } - fn, dn = dn, path.Dir(dn) - } - } - for fn := range files { - dn := path.Dir(fn) - if fn != dn { - fs.dirs[dn] = append(fs.dirs[dn], path.Base(fn)) - } - } - for _, s := range fs.dirs { - sort.Strings(s) - } - return fs, nil -} - -var _ = os.FileInfo(dirInfo{}) - -type dirInfo struct { - name string -} - -func (di dirInfo) Name() string { return path.Base(di.name) } -func (di dirInfo) Size() int64 { return 0 } -func (di dirInfo) Mode() os.FileMode { return 0755 | os.ModeDir } -func (di dirInfo) ModTime() time.Time { return time.Time{} } -func (di dirInfo) IsDir() bool { return true } -func (di dirInfo) Sys() interface{} { return nil } - -// Open returns a file matching the given file name, or os.ErrNotExists if -// no file matching the given file name is found in the archive. -// If a directory is requested, Open returns the file named "index.html" -// in the requested directory, if that file exists. -func (fs *statikFS) Open(name string) (http.File, error) { - name = filepath.ToSlash(filepath.Clean(name)) - if f, ok := fs.files[name]; ok { - return newHTTPFile(f), nil - } - return nil, os.ErrNotExist -} - -func newHTTPFile(file file) *httpFile { - if file.IsDir() { - return &httpFile{file: file, isDir: true} - } - return &httpFile{file: file, reader: bytes.NewReader(file.data)} -} - -// httpFile represents an HTTP file and acts as a bridge -// between file and http.File. -type httpFile struct { - file - - reader *bytes.Reader - isDir bool - dirIdx int -} - -// Read reads bytes into p, returns the number of read bytes. -func (f *httpFile) Read(p []byte) (n int, err error) { - if f.reader == nil && f.isDir { - return 0, io.EOF - } - return f.reader.Read(p) -} - -// Seek seeks to the offset. -func (f *httpFile) Seek(offset int64, whence int) (ret int64, err error) { - return f.reader.Seek(offset, whence) -} - -// Stat stats the file. -func (f *httpFile) Stat() (os.FileInfo, error) { - return f, nil -} - -// IsDir returns true if the file location represents a directory. -func (f *httpFile) IsDir() bool { - return f.isDir -} - -// Readdir returns an empty slice of files, directory -// listing is disabled. -func (f *httpFile) Readdir(count int) ([]os.FileInfo, error) { - var fis []os.FileInfo - if !f.isDir { - return fis, nil - } - di, ok := f.FileInfo.(dirInfo) - if !ok { - return nil, fmt.Errorf("failed to read directory: %q", f.Name()) - } - - // If count is positive, the specified number of files will be returned, - // and if non-positive, all remaining files will be returned. - // The reading position of which file is returned is held in dirIndex. - fnames := f.file.fs.dirs[di.name] - flen := len(fnames) - - // If dirIdx reaches the end and the count is a positive value, - // an io.EOF error is returned. - // In other cases, no error will be returned even if, for example, - // you specified more counts than the number of remaining files. - start := f.dirIdx - if start >= flen && count > 0 { - return fis, io.EOF - } - var end int - if count <= 0 { - end = flen - } else { - end = start + count - } - if end > flen { - end = flen - } - for i := start; i < end; i++ { - fis = append(fis, f.file.fs.files[path.Join(di.name, fnames[i])].FileInfo) - } - f.dirIdx += len(fis) - return fis, nil -} - -func (f *httpFile) Close() error { - return nil -} - -func unzip(zf *zip.File) ([]byte, error) { - rc, err := zf.Open() - if err != nil { - return nil, err - } - defer rc.Close() - return ioutil.ReadAll(rc) -} diff --git a/backend/vendor/github.com/rakyll/statik/fs/walk.go b/backend/vendor/github.com/rakyll/statik/fs/walk.go deleted file mode 100644 index f4eb37d1a9..0000000000 --- a/backend/vendor/github.com/rakyll/statik/fs/walk.go +++ /dev/null @@ -1,79 +0,0 @@ -// Copyright 2014 Google Inc. All Rights Reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package fs - -import ( - "bytes" - "io" - "net/http" - "path" - "path/filepath" -) - -// Walk walks the file tree rooted at root, -// calling walkFn for each file or directory in the tree, including root. -// All errors that arise visiting files and directories are filtered by walkFn. -// -// As with filepath.Walk, if the walkFn returns filepath.SkipDir, then the directory is skipped. -func Walk(hfs http.FileSystem, root string, walkFn filepath.WalkFunc) error { - dh, err := hfs.Open(root) - if err != nil { - return err - } - di, err := dh.Stat() - if err != nil { - return err - } - fis, err := dh.Readdir(-1) - dh.Close() - if err = walkFn(root, di, err); err != nil { - if err == filepath.SkipDir { - return nil - } - return err - } - for _, fi := range fis { - fn := path.Join(root, fi.Name()) - if fi.IsDir() { - if err = Walk(hfs, fn, walkFn); err != nil { - if err == filepath.SkipDir { - continue - } - return err - } - continue - } - if err = walkFn(fn, fi, nil); err != nil { - if err == filepath.SkipDir { - continue - } - return err - } - } - return nil -} - -// ReadFile reads the contents of the file of hfs specified by name. -// Just as ioutil.ReadFile does. -func ReadFile(hfs http.FileSystem, name string) ([]byte, error) { - fh, err := hfs.Open(name) - if err != nil { - return nil, err - } - var buf bytes.Buffer - _, err = io.Copy(&buf, fh) - fh.Close() - return buf.Bytes(), err -} diff --git a/backend/vendor/modules.txt b/backend/vendor/modules.txt index d1736bdd85..c44ec46dac 100644 --- a/backend/vendor/modules.txt +++ b/backend/vendor/modules.txt @@ -168,9 +168,6 @@ github.com/pkg/errors # github.com/pmezard/go-difflib v1.0.0 ## explicit github.com/pmezard/go-difflib/difflib -# github.com/rakyll/statik v0.1.7 -## explicit; go 1.12 -github.com/rakyll/statik/fs # github.com/rs/xid v1.4.0 ## explicit; go 1.12 github.com/rs/xid diff --git a/docker-init.sh b/docker-init.sh index 0b46831696..da8a6efc8c 100755 --- a/docker-init.sh +++ b/docker-init.sh @@ -3,17 +3,29 @@ echo "prepare environment" # replace {% REMARK_URL %} by content of REMARK_URL variable find . -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|${REMARK_URL}|g" {} \; -if [ -n "${SITE_ID}" ]; then - #replace "site_id: 'remark'" by SITE_ID - sed -i "s|'remark'|'${SITE_ID}'|g" /srv/web/*.html +# replace 'site_id: "remark"' by the first SITE from the comma-separated list of IDs, if present +if [ -n "${SITE}" ]; then + sep=',' + case ${SITE} in + *"$sep"*) + export single_site_id=${SITE%%"$sep"*} + echo "multiple site IDs passed in SITE (\"${SITE}\"): using \"${single_site_id}\" in frontend site_id" + ;; + *) + echo "using non-standard frontend site_id from SITE variable (\"${SITE}\") instead of \"remark\"" + export single_site_id=$SITE + ;; + esac + echo "single_site_id: ${single_site_id}" + sed -i "s|site_id:\"[^\"]*\"|site_id:\"${single_site_id}\"|g" /srv/web/*.html fi if [ -d "/srv/var" ]; then - echo "changing ownership of /srv/var to app:app (remark42 user inside the container)" - chown -R app:app /srv/var || echo "WARNING: /srv/var ownership change failed, if application will fail that might be the reason" + echo "changing ownership of /srv/var to app:app (remark42 user inside the container)" + chown -R app:app /srv/var || echo "WARNING: /srv/var ownership change failed, if application will fail that might be the reason" else - echo "ERROR: /srv/var doesn't exist, which means that state of the application" - echo "ERROR: will be lost on container stop or restart." - echo "ERROR: Please mount local directory to /srv/var in order for it to work." - exit 199 + echo "ERROR: /srv/var doesn't exist, which means that state of the application" + echo "ERROR: will be lost on container stop or restart." + echo "ERROR: Please mount local directory to /srv/var in order for it to work." + exit 199 fi diff --git a/site/Dockerfile b/site/Dockerfile index c6119048d0..0edb01c9da 100644 --- a/site/Dockerfile +++ b/site/Dockerfile @@ -7,6 +7,14 @@ RUN yarn build RUN ls -la /site FROM ghcr.io/umputun/reproxy +LABEL org.opencontainers.image.authors="Umputun " \ + org.opencontainers.image.description="Remark42 site" \ + org.opencontainers.image.documentation="https://github.com/umputun/remark42/tree/master/site" \ + org.opencontainers.image.licenses="MIT" \ + org.opencontainers.image.source="https://github.com/umputun/remark42.git" \ + org.opencontainers.image.title="Remark42 site" \ + org.opencontainers.image.url="https://remark42.com/" + COPY --from=build /site/build /srv/site EXPOSE 8080 USER app diff --git a/site/src/docs/contributing/backend/index.md b/site/src/docs/contributing/backend/index.md index e725d39828..7a27ce15d7 100644 --- a/site/src/docs/contributing/backend/index.md +++ b/site/src/docs/contributing/backend/index.md @@ -36,13 +36,13 @@ In order to have working Remark42 installation you need once to copy frontend st # frontend files docker pull umputun/remark42:master docker create -ti --name remark42files umputun/remark42:master sh -docker cp remark42files:/srv/web/ ./backend/ +docker cp remark42files:/srv/web/ ./backend/app/cmd/ docker rm -f remark42files # fix frontend files to point to the right URL ## Mac version -find -E ./backend/web -regex '.*\.(html|js|mjs)$' -print -exec sed -i '' "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; +find -E ./backend/app/cmd/web -regex '.*\.(html|js|mjs)$' -print -exec sed -i '' "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; ## Linux version -find ./backend/web -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; +find ./backend/app/cmd/web -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REMARK_URL %}|http://127.0.0.1:8080|g" {} \; ``` To run backend - `cd backend; go run app/main.go server --dbg --secret=12345 --url=http://127.0.0.1:8080 --admin-passwd=password --site=remark`. It stars backend service with embedded bolt store on port `8080` with basic auth, allowing to authenticate and run requests directly, like this: