© 2020 Docspell, v{{site.version}}
- |""".stripMargin - ), - micrositeName := "Docspell", - micrositeDescription := "Auto-tagging Document Organizer", - micrositeDocumentationUrl := "doc", - micrositeDocumentationLabelDescription := "Documentation", - micrositeFavicons := Seq(microsites.MicrositeFavicon("favicon.png", "96x96")), - micrositeAuthor := "eikek", - micrositeGithubOwner := "eikek", - micrositeGithubRepo := "docspell", - micrositeGitterChannel := false, - micrositeShareOnSocial := false, - micrositeHighlightLanguages ++= Seq("json", "javascript"), - micrositeEditButton := Some(microsites.MicrositeEditButton("Improve this page", "/edit/master/modules/microsite/docs/{{ page.path }}")), - fork in run := true, - micrositeCompilingDocsTool := WithMdoc, - mdocVariables := Map( - "VERSION" -> version.value, - "PVERSION" -> version.value.replace('.', '_') - ), - micrositeExtraMdFiles := Map( - file("Changelog.md") -> ExtraMdFileConfig( - "changelog.md", - "docs", - Map("title" -> "Changelog", "permalink" -> "changelog") - ) - ), Compile/resourceGenerators += Def.task { - val jekyllOut = resourceManaged.value/"main"/"jekyll" + val templateOut = baseDirectory.value/"site"/"templates"/"shortcodes" + val staticOut = baseDirectory.value/"site"/"static"/"openapi" + IO.createDirectories(Seq(templateOut, staticOut)) val logger = streams.value.log - val templates = Seq( - (resourceDirectory in (restserver, Compile)).value / "reference.conf" -> jekyllOut /"_includes"/"server.conf", - (resourceDirectory in (joex, Compile)).value / "reference.conf" -> jekyllOut/"_includes"/"joex.conf", - (LocalRootProject / baseDirectory).value / "tools" / "exim" / "exim.conf" -> jekyllOut/ "_includes"/"sample-exim.conf" - ) - val res1 = templates.map { case (s, t) => - logger.info(s"Copying $s -> $t") - IO.write(t, "{% raw %}\n") - IO.append(t, IO.readBytes(s)) - IO.write(t, "\n{% endraw %}", append = true) - t - } - val files = Seq( - (resourceDirectory in (restapi, Compile)).value/"docspell-openapi.yml" -> jekyllOut/"openapi"/"docspell-openapi.yml" + (resourceDirectory in (restserver, Compile)).value / "reference.conf" -> templateOut /"server.conf", + (resourceDirectory in (joex, Compile)).value / "reference.conf" -> templateOut/"joex.conf", + (LocalRootProject / baseDirectory).value / "tools" / "exim" / "exim.conf" -> templateOut/"sample-exim.conf", + (resourceDirectory in (restapi, Compile)).value/"docspell-openapi.yml" -> staticOut/"docspell-openapi.yml", + (restapi/Compile/openapiStaticDoc).value -> staticOut/"docspell-openapi.html" ) IO.copy(files) - res1 ++ files.map(_._2) + files.map(_._2) }.taskValue, Compile/resourceGenerators += Def.task { - val staticDoc = (restapi/Compile/openapiStaticDoc).value - val target = resourceManaged.value/"main"/"jekyll"/"openapi"/"docspell-openapi.html" - IO.copy(Seq(staticDoc -> target)) + val changelog = (LocalRootProject / baseDirectory).value / "Changelog.md" + val targetDir = baseDirectory.value/"site"/"content"/"docs"/"changelog" + IO.createDirectory(targetDir) + val target = targetDir/"_index.md" + + IO.write(target, """|+++ + |title = "Changelog" + |description = "See what changed between releases." + |weight = 10 + |insert_anchor_links = "right" + |[extra] + |maketoc = false + |+++ + |""".stripMargin) + IO.append(target, IO.readBytes(changelog)) Seq(target) - }.taskValue + }.taskValue ) + val root = project.in(file(".")). settings(sharedSettings). settings(noPublish). diff --git a/modules/microsite/docs/dev.md b/modules/microsite/docs/dev.md index 96a0954b..3211d3e7 100644 --- a/modules/microsite/docs/dev.md +++ b/modules/microsite/docs/dev.md @@ -97,7 +97,7 @@ the nix package manager and to integrate it into NixOS. The modules can be build by building the `configuration-test.nix` file together with some nixpkgs version. For example: -``` shell +``` bash nixos-rebuild build-vm -I nixos-config=./configuration-test.nix \ -I nixpkgs=https://github.com/NixOS/nixpkgs-channels/archive/nixos-19.09.tar.gz ``` @@ -108,21 +108,21 @@ the system configuration can be found behind the `./result/system` symlink. So it is possible to look at the generated systemd config for example: -``` shell +``` bash cat result/system/etc/systemd/system/docspell-joex.service ``` And with some more commands (there probably is an easier way…) the config file can be checked: -``` shell +``` bash cat result/system/etc/systemd/system/docspell-joex.service | grep ExecStart | cut -d'=' -f2 | xargs cat | tail -n1 | awk '{print $NF}'| sed 's/.$//' | xargs cat | jq ``` To see the module in action, the vm can be started (the first line sets more memory for the vm): -``` shell +``` bash export QEMU_OPTS="-m 2048" ./result/bin/run-docspelltest-vm ``` diff --git a/modules/microsite/docs/doc/configure.md b/modules/microsite/docs/doc/configure.md index 4a6ad60a..c0bf89aa 100644 --- a/modules/microsite/docs/doc/configure.md +++ b/modules/microsite/docs/doc/configure.md @@ -117,7 +117,7 @@ full-text-search { This key is required if you want docspell to drop and re-create the entire index. This is possible via a REST call: -``` shell +``` bash $ curl -XPOST http://localhost:7880/api/v1/open/fts/reIndexAll/test123 ``` diff --git a/modules/microsite/docs/doc/emailsettings.md b/modules/microsite/docs/doc/emailsettings.md index 050f90ac..ca3a7c1f 100644 --- a/modules/microsite/docs/doc/emailsettings.md +++ b/modules/microsite/docs/doc/emailsettings.md @@ -132,7 +132,7 @@ Download the `oauth2.py` script from [here](https://github.com/google/gmail-oauth2-tools) and first create an *oauth2-token*: -``` shell +``` bash ./oauth2.py --user=your.name@gmail.com \ --client_id=106701....d8c.apps.googleusercontent.com \ --client_secret=5Z1...Kir_t \ diff --git a/modules/microsite/docs/doc/tools/smtpgateway.md b/modules/microsite/docs/doc/tools/smtpgateway.md index 9a73fdcf..86090b43 100644 --- a/modules/microsite/docs/doc/tools/smtpgateway.md +++ b/modules/microsite/docs/doc/tools/smtpgateway.md @@ -90,7 +90,7 @@ notes about the used options (see `man curl`): Go into the `tools/exim` directory and build the docker image: -``` shell +``` bash docker build -t ds-exim:latest -f exim.dockerfile . ``` @@ -114,7 +114,7 @@ variables as needed. Finally start the container: -``` shell +``` bash docker-compose up ``` @@ -169,7 +169,7 @@ The mail is processed and results in an item: However, if a mail is to an unknown collective or not to the configured local domain, the server rejects it immediately: -``` shell +``` bash fish ~> telnet localhost 25 Trying ::1... Connected to localhost. diff --git a/project/build.nix b/project/build.nix index 522d61e9..fb584dde 100644 --- a/project/build.nix +++ b/project/build.nix @@ -9,6 +9,8 @@ buildFHSUserEnv { name = "docspell-sbt"; targetPkgs = pkgs: with pkgs; [ netcat jdk8 wget which zsh dpkg sbt git elmPackages.elm ncurses fakeroot mc jekyll + zola yarn + # haskells http client needs this (to download elm packages) iana-etc ]; diff --git a/website/README.md b/website/README.md new file mode 100644 index 00000000..2dbebd8d --- /dev/null +++ b/website/README.md @@ -0,0 +1,30 @@ +# Website + +This is the docspell website and documentation. + +## Building + +The website is created using [zola](https://github.com/getzola/zola) +static site generator. The (very minimal) dynamic parts are written in +Elm. + +The `build.sh` script builds the site. + + +## Development + +Install things by running `yarn install`. + +Open two terminals. In first run: + +``` shell +nix-shell --run ./run-elm.sh +``` + +and in the second + +``` shell +nix-shell --run "cd site && zola serve" +``` + +Open browser at `localhost:1111`. diff --git a/website/build.sh b/website/build.sh new file mode 100755 index 00000000..c9d9e671 --- /dev/null +++ b/website/build.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash + +set -e + +yarn install +elm make --output site/static/js/bundle.js --optimize elm/Main.elm +cd site +zola build +cd .. + +echo "Site is in site/public." diff --git a/website/elm-analyse.json b/website/elm-analyse.json new file mode 100644 index 00000000..837c4ada --- /dev/null +++ b/website/elm-analyse.json @@ -0,0 +1,9 @@ +{ + "excludedPaths": [ + "modules/webapp/target/elm-src/" + ], + "checks" : { + "ImportAll": false, + "SingleFieldRecord": false + } +} diff --git a/website/elm.json b/website/elm.json new file mode 100644 index 00000000..daaa0710 --- /dev/null +++ b/website/elm.json @@ -0,0 +1,28 @@ +{ + "type": "application", + "source-directories": [ + "elm" + ], + "elm-version": "0.19.1", + "dependencies": { + "direct": { + "elm/browser": "1.0.2", + "elm/core": "1.0.5", + "elm/html": "1.0.0", + "elm/random": "1.0.0", + "elm-community/random-extra": "3.1.0", + "elm-explorations/markdown": "1.0.0" + }, + "indirect": { + "elm/json": "1.1.3", + "elm/time": "1.0.0", + "elm/url": "1.0.0", + "elm/virtual-dom": "1.0.2", + "owanturist/elm-union-find": "1.0.0" + } + }, + "test-dependencies": { + "direct": {}, + "indirect": {} + } +} diff --git a/website/elm/ExtraAttr.elm b/website/elm/ExtraAttr.elm new file mode 100644 index 00000000..7d7fb64c --- /dev/null +++ b/website/elm/ExtraAttr.elm @@ -0,0 +1,36 @@ +module ExtraAttr exposing (..) + +import Html exposing (..) +import Html.Attributes exposing (..) + + +ariaExpanded : Bool -> Attribute msg +ariaExpanded flag = + attribute "aria-expanded" + (if flag then + "true" + + else + "false" + ) + + +ariaHidden : Bool -> Attribute msg +ariaHidden flag = + attribute "aria-hidden" + (if flag then + "true" + + else + "false" + ) + + +ariaLabel : String -> Attribute msg +ariaLabel name = + attribute "aria-label" name + + +role : String -> Attribute msg +role name = + attribute "role" name diff --git a/website/elm/Feature.elm b/website/elm/Feature.elm new file mode 100644 index 00000000..8edece1d --- /dev/null +++ b/website/elm/Feature.elm @@ -0,0 +1,110 @@ +module Feature exposing (..) + +import Html exposing (..) +import Html.Attributes exposing (..) +import Markdown + + +type alias Feature = + { image : String + , header : String + , description : String + } + + +featureBox : Int -> Feature -> Html msg +featureBox index f = + case isOdd index of + False -> + div [ class "columns is-vcentered box mb-5" ] + [ div [ class "column is-three-quarter" ] + [ figure [ class "image is-2by1 feature-image" ] + [ img [ src f.image ] [] + ] + ] + , div [ class "column" ] + [ h2 [ class "title" ] + [ text f.header + ] + , Markdown.toHtml [] + f.description + ] + ] + + True -> + div [ class "columns is-vcentered box mb-5" ] + [ div [ class "column is-three-quarter" ] + [ h2 [ class "title" ] + [ text f.header + ] + , Markdown.toHtml [] + f.description + ] + , div [ class "column" ] + [ figure [ class "image is-2by1 feature-image" ] + [ img [ src f.image ] [] + ] + ] + ] + + +features : List Feature +features = + [ { image = "img/user-feature.png" + , header = "Multi-User per Account" + , description = """ +Each account (a *collective*) can have multiple users that share the +same files. For example, everyone in your family can work with your +files while using their own account with their own settings. +""" + } + , { image = "img/ocr-feature.png" + , header = "Text Extraction with OCR" + , description = """ +Text is extracted from all files. For scanned documents/images, OCR is used by utilising tesseract. The text is analysed and is available for full-text search. +""" + } + , { image = "img/filetype-feature.svg" + , header = "Support for many files" + , description = """ +Docspell can read many file types. ZIP and EML (e-mail file format) files are extracted and their contents imported. +""" + } + , { image = "img/convertpdf-feature.svg" + , header = "Conversion to PDF" + , description = """ +All files are converted to PDF. Don't worry about the originals. Original files are stored, too and can be downloaded untouched. When creating PDFs from image data (often returned from scanners), the resulting PDF contains the extracted text and is searchable. +""" + } + , { image = "img/fts-feature.png" + , header = "Full-Text Search" + , description = """ +The extracted text of all files and some properties, like names and notes, are available for full-text search. Full-text search can also be used to further constrain the results of the search-menu where you can search by tags, correspondent, etc. +""" + } + , { image = "img/sendmail-feature.png" + , header = "Send via E-Mail" + , description = """ + +Users can define SMTP settings in the app and are then able to send items out via E-Mail. This is often useful to share with other people. There is e-mail-address completion from your address book, of course. + +""" + } + , { image = "img/scanmailbox-feature.png" + , header = "Import Mailboxes" + , description = """ +Users can define IMAP settings so that docspell can import their e-mails. This can be done periodically based on a schedule. Imported mails can be moved away into another folder or deleted. +""" + } + , { image = "img/notify-feature.png" + , header = "Notifications" + , description = """ +Users can be notified by e-mail for documents whose due-date comes closer. +""" + } + ] + + +isOdd : Int -> Bool +isOdd num = + modBy 2 num == 1 diff --git a/website/elm/GetStarted.elm b/website/elm/GetStarted.elm new file mode 100644 index 00000000..9e6df77c --- /dev/null +++ b/website/elm/GetStarted.elm @@ -0,0 +1,91 @@ +module GetStarted exposing (..) + +import Html exposing (..) +import Html.Attributes exposing (..) +import Icons +import Markdown + + +getStarted : String -> List (Html msg) +getStarted version = + [ div [ class "content container is-size-5" ] + [ Markdown.toHtml [] + """Docspell consists of several components. The easiest way to get started is probably to use docker and +[docker-compose](https://docs.docker.com/compose/).""" + , Markdown.toHtml [] + ("""1. Clone the github repository + ```bash + $ git clone https://github.com/eikek/docspell + ``` + Alternatively, [download](https://github.com/eikek/docspell/archive/v""" + ++ version + ++ """.zip) the sources and extract the zip file. +2. Change into the `docker` directory: + ```bash + $ cd docspell/docker + ``` +3. Run `docker-compose up`: + + ```bash + $ export DOCSPELL_HEADER_VALUE="my-secret-123" + $ docker-compose up + ``` + + The environment variable defines a secret that is shared between + some containers. You can define whatever you like. Please see the + [`consumedir.sh`](doc/tools/consumedir#docker) docs for additional + info. +4. Goto