new website

.github/workflows/gh-pages.yml

@@ -1,35 +1,23 @@
 name: build and deploy github pages
+
 on:
   push:
     branches:
       - development
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
     steps:
-      - uses: actions/checkout@v2
+      - name: checkout
+        uses: actions/[email protected]
         with:
           submodules: "recursive"
           fetch-depth: 0       # Fetch all history for .GitInfo and .Lastmod
+
+      - name: build_and_deploy
+        uses: shalzz/[email protected]
+        env:
+          PAGES_BRANCH: gh-pages
+          TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Setup Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.9'
-          architecture: 'x64'
-
-      - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install mkdocs
-          python3 -m pip install mkdocs-material
-
-      - name: Build site
-        run: mkdocs build
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./site
-          keep_files: true

.gitignore

@@ -1,2 +1 @@
-venv/
-site/
+docs/

config.toml

@@ -0,0 +1,111 @@
+# The URL the site will be built for
+base_url = "https://photos.network"
+
+title = "Photos.network"
+description = "The main website for Photos.network a self-hosted and open source photo management service."
+
+default_language = "en"
+
+output_dir = "docs"
+
+# Whether to automatically compile all Sass files in the sass directory
+compile_sass = true
+
+ignored_content = []
+
+generate_feed = true
+
+# The filename to use for the feed. Used as the template filename, too.
+# Defaults to "atom.xml", which has a built-in template that renders an Atom 1.0 feed.
+# There is also a built-in template "rss.xml" that renders an RSS 2.0 feed.
+feed_filename = "atom.xml"
+
+# Whether to build a search index to be used later on by a JavaScript library
+build_search_index = true
+
+
+[markdown]
+# Whether to do syntax highlighting
+highlight_code = true
+
+
+[search]
+# Whether to include the title of the page/section in the index
+include_title = true
+# Whether to include the description of the page/section in the index
+include_description = true
+# Whether to include the path of the page/section in the index
+include_path = true
+# Whether to include the rendered content of the page/section in the index
+include_content = true
+# At which character to truncate the content to. Useful if you have a lot of pages and the index would
+# become too big to load on the site. Defaults to not being set.
+truncate_content_length = 100
+
+
+
+[languages.de]
+build_search_index = true
+title = "Photos.network"
+
+[extra]
+enable_search = false
+enable_sidebar = true
+enable_adsense = false
+enable_multilingue = false
+enable_darkmode = false
+
+[extra.lang]
+items = [
+    { lang = "en", links = [
+        { base_url = "/", name = "English" },
+        { base_url = "/de", name = "German" },
+    ] },
+    { lang = "de", links = [
+        { base_url = "/", name = "Englisch" },
+        { base_url = "/de", name = "Deutsch" },
+    ] },
+]
+
+[extra.navbar]
+items = [
+    { lang = "en", links = [
+        { url = "/", name = "Home" },
+        #{ url = "/installation", name = "Installation" },
+        #{ url = "/documentation", name = "Documentation" },
+    ] },
+    { lang = "de", links = [
+        { url = "/de", name = "Start" },
+        #{ url = "/de/installation", name = "Installation" },
+        #{ url = "/de/documentation", name = "Dokumentation" },
+    ]}
+]
+
+[extra.sidebar]
+items = []
+
+# Index page
+[extra.index]
+title = "Photos.network"
+image = "logo.png"
+image_alt = "Logo of the Photos.network project."
+
+[extra.default_author]
+name = "Stürmer, Benjamin"
+
+[extra.social]
+github = "https://github.com/photos-network"
+twitter = "https://twitter.com/photosnetwork"
+email = "[email protected]"
+linkedin = ""
+stackoverflow = ""
+telegram = ""
+
+[extra.favicon]
+favicon = "/icons/favicon.ico"
+favicon_16x16 = "/icons/favicon-16x16.png"
+favicon_32x32 = "/icons/favicon-32x32.png"
+apple_touch_icon = "/icons/apple-touch-icon.png"
+android_chrome_512 = "/icons/android-icon-310x310.png"
+android_chrome_192 = "/icons/android-icon-192x192.png"
+manifest = "/icons/site.webmanifest"

content/_index.de.md

@@ -0,0 +1,6 @@
++++
+title = "Landing"
+description = "Photos.network"
+date = 2020-12-28
++++
+Photos.network ist ein selbstgehosteter Dienst zum Speichern und Teilen von Fotos, bei dem der Datenschutz im Vordergrund steht.

content/_index.md

@@ -0,0 +1,6 @@
++++
+title = "Landing"
+description = "Photos.network"
+date = 2020-12-28
++++
+Photos.network is a self-hosted, privacy first photo storage and sharing service.

content/documentation.md

@@ -0,0 +1,97 @@
++++
+title = "Configuration"
+description = "This is fun"
+date = 2020-12-28
++++
+
+## Minimal configuration
+```json
+{
+  "internal_url": "192.168.0.1",
+  "external_url": "photos.external.com",
+  "clients": [
+    {
+      "name": "Frontend",
+      "client_id": "<random id>",
+      "client_secret": "<random secret>",
+      "redirect_uris": [
+        "http://127.0.0.1:7778/callback"
+      ]
+    },
+    {
+      "name": "Android App",
+      "client_id": "<random id>",
+      "client_secret": "<random secret>",
+      "redirect_uris": [
+        "photosapp://authenticate"
+      ]
+    }
+  ],
+  "addons": [
+    {
+      "name": "api"
+    }
+  ]
+}
+```
+
+
+| Properties          | Description                          |
+| ------------------- | ------------------------------------ |
+| `internal_url`      | Indicates the internal network address. |
+| `external_url`      | The external network address e.g.: used to create links for sharing. |
+| `clients`           | List of clients e.g. Web frontend or Android. |
+| `addons`            | List of addons and their custom configurations. |
+
+
+## Nginx
+
+It is recommended to run **photos.network** behind a reverse proxy like nginx or HAProxy.
+First of all, it increases the performance and it prevents from many attacks based on malformed http requests.
+
+#### Nginx + Round-robin
+
+```conf
+upstream core {
+  server 127.0.0.1:7777 fail_timeout=0;
+}
+
+upstream frontend {
+ server 127.0.0.1:7778 fail_timeout=0; 
+}
+
+server {
+  listen 80;
+  return 301              https://$host$request_uri;
+}
+
+server {
+  listen                  443 ssl http2;
+  listen                  [::]:443 ssl http2;
+  client_max_body_size    4G;
+
+  server_name             photos.example.com;
+
+  ssl_certificate         /etc/secrets/cert.pem;
+  ssl_certificate_key     /etc/secrets/key.pem;
+
+  location / {
+    proxy_set_header      Host $http_host;
+    proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header      X-Forwarded-Proto $scheme;
+    proxy_set_header      X-Real-IP $remote_addr;
+    proxy_redirect        off;
+    proxy_buffering       off;
+    proxy_pass            http://frontend;
+  }
+
+  location /api {
+    proxy_pass            http://core;
+  }
+
+  location /oauth {
+    proxy_pass            http://core;
+  }
+}
+
+```

content/privacy.md

@@ -0,0 +1,8 @@
++++
+title = "Privacy"
+description = "Privacy policy for the website and mobile apps"
+date = 2020-12-28
++++
+
+[Photos.network](https://photos.network) is focusing on privacy and will not track any user data.
+

docs/security.md → content/security.md

@@ -1,7 +1,12 @@
-# Security
++++
+title = "Security"
+description = "How to handle found security vulnerabilities"
+date = 2020-12-28
++++
 
-If you think that you have found a security vulnerability in Photos.network, please disclose it to us via our security e-mail address at [email protected].
+If you think that you have found a security vulnerability in Photos.network, please disclose it to us via our security e-mail address at [[email protected]](mailto:[email protected]).
 
 Please do not make vulnerabilities public without notifying us and giving us at least 2 weeks to respond.
 
 If you are going to write about Photos.network’s security, please get in touch, so we can make sure that all claims are correct.
+