1.5.0

fallback route & dep updates

CHANGELOG.md

@@ -5,7 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.4.0] - 2022-01-16
+## [1.5.0] - 2022-05-14
+
+### Added
+
+- Links in notes are not highlighted and can be directly clicked #30.
+
+## [1.4.1] - 2022-03-05
+
+### Fixed
+
+- Router in prod build.
+
+## [1.4.0] - 2022-03-02
 
 ### Added
 

README.md

@@ -49,9 +49,12 @@ of the notes even if it tried to.
 ## Environment Variables
 
 | Variable         | Default           | Description                                                                             |
-| ------------ | ----------------- | --------------------------------------------------------------------------------------- |
+| ---------------- | ----------------- | --------------------------------------------------------------------------------------- |
 | `MEMCACHE`       | `memcached:11211` | Memcached URL to connect to.                                                            |
 | `SIZE_LIMIT`     | `1 KiB`           | Max size for body. Accepted values according to [byte-unit](https://docs.rs/byte-unit/) |
+| `MAX_VIEWS`      | `100`             | Maximal number of views.                                                                |
+| `MAX_EXPIRATION` | `360`             | Maximal expiration in minutes.                                                          |
+| `ALLOW_ADVANCED` | `true`            | Allow custom configuration. If set to `false` all notes will be one view only.          |
 
 ## Deployment
 
@@ -124,11 +127,35 @@ services:
 
 ## Development
 
-1. Clone
-2. run `pnpm i` in the root and and client `client/` folders.
-3. Run `pnpm run dev` to start development.
+**Requirements**
 
-Running `npm run dev` in the root folder will start the following things
+- `pnpm`: `>=6`
+- `node`: `>=14`
+- `rust`: edition `2021`
+
+**Install**
+
+```bash
+pnpm install
+pnpm --prefix frontend install
+
+# Also you need cargo watch if you don't already have it installed.
+# https://lib.rs/crates/cargo-watch
+cargo install cargo-watch
+```
+
+**Run**
+
+Make sure you have docker running.
+
+> If you are on `macOS` you might need to disable AirPlay Receiver as it uses port 5000 (So stupid...)
+> https://developer.apple.com/forums/thread/682332
+
+```bash
+pnpm run dev
+```
+
+Running `pnpm run dev` in the root folder will start the following things:
 
 - a memcache docker container
 - rust backend with hot reload

backend/Cargo.lock

@@ -398,7 +398,7 @@ dependencies = [
 
 [[package]]
 name = "cryptgeon"
-version = "1.4.0"
+version = "1.5.0"
 dependencies = [
  "actix-files",
  "actix-web",

backend/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cryptgeon"
-version = "1.4.0"
+version = "1.5.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2021"
 

backend/src/client.rs

@@ -1,5 +1,5 @@
-use actix_files::Files;
-use actix_web::web;
+use actix_files::{Files, NamedFile};
+use actix_web::{web, Result};
 
 pub fn init(cfg: &mut web::ServiceConfig) {
     cfg.service(
@@ -8,3 +8,7 @@ pub fn init(cfg: &mut web::ServiceConfig) {
             .use_etag(true),
     );
 }
+
+pub async fn index() -> Result<NamedFile> {
+    Ok(NamedFile::open("./frontend/build/index.html")?)
+}

backend/src/main.rs

@@ -1,4 +1,4 @@
-use actix_web::{middleware, App, HttpServer};
+use actix_web::{middleware, web, App, HttpServer};
 use dotenv::dotenv;
 
 #[macro_use]
@@ -22,6 +22,7 @@ async fn main() -> std::io::Result<()> {
             .configure(size::init)
             .configure(api::init)
             .configure(client::init)
+            .default_service(web::to(client::index))
     })
     .bind("0.0.0.0:5000")?
     .run()

examples/scratch/README.md

@@ -0,0 +1,161 @@
+# Install from scratch.
+
+This is a tiny guide to install cryptgeon on (probably) any unix system (and maybe windows?) from scratch using traefik as the proxy, which will manage certificates and handle https for us.
+
+1. Install Docker & Docker Compose.
+2. Install Traefik.
+3. Run the cryptgeon.
+4. [Optional] install watchtower to keep up to date.
+
+## Install Docker & DOcker Compose
+
+- [Docker](https://docs.docker.com/engine/install/)
+- [Compose](https://docs.docker.com/compose/install/)
+
+## Install Traefik 2.0
+
+[Traefik](https://doc.traefik.io/traefik/) is a router & proxy that makes deployment of containers incredibly easy. It will manage all the https certificates, routing, etc.
+
+```sh
+/foo/bar/traefik/
+├── docker-compose.yaml
+└── traefik.yaml
+```
+
+```yaml
+# docker-compose.yaml
+
+version: '3.8'
+services:
+  traefik:
+    image: traefik:2.6
+    restart: unless-stopped
+    ports:
+      - '80:80'
+      - '443:443'
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+      - ./traefik.yaml:/etc/traefik/traefik.yaml:ro
+      - ./data:/data
+    labels:
+      - 'traefik.enable=true'
+
+      # HTTP to HTTPS redirection
+      - 'traefik.http.routers.http_catchall.rule=HostRegexp(`{any:.+}`)'
+      - 'traefik.http.routers.http_catchall.entrypoints=insecure'
+      - 'traefik.http.routers.http_catchall.middlewares=https_redirect'
+      - 'traefik.http.middlewares.https_redirect.redirectscheme.scheme=https'
+      - 'traefik.http.middlewares.https_redirect.redirectscheme.permanent=true'
+
+networks:
+  default:
+    external: true
+    name: proxy
+```
+
+```yaml
+# traefik.yaml
+
+api:
+  dashboard: true
+
+# Define HTTP and HTTPS entrypoint
+entryPoints:
+  insecure:
+    address: ':80'
+  secure:
+    address: ':443'
+
+# Dynamic configuration will come from docker labels
+providers:
+  docker:
+    endpoint: 'unix:///var/run/docker.sock'
+    network: 'proxy'
+    exposedByDefault: false
+
+# Enable acme with http file challenge
+certificatesResolvers:
+  le:
+    acme:
+      email: me@example.org
+      storage: /data/acme.json
+      httpChallenge:
+        entryPoint: insecure
+```
+
+**Run**
+
+```sh
+docker network create proxy
+docker-compose up -d
+```
+
+## Cryptgeon
+
+Create another docker-compose.yaml file in another folder. We will assume that the domain is `cryptgeon.example.org`.
+
+```sh
+/foo/bar/cryptgeon/
+└── docker-compose.yaml
+```
+
+```yaml
+version: '3.8'
+
+networks:
+  proxy:
+    external: true
+
+services:
+  memcached:
+    image: memcached:1-alpine
+    restart: unless-stopped
+    entrypoint: memcached -m 256M -I 4M # Limit to 128 MB Ram, customize at free will.
+
+  app:
+    image: cupcakearmy/cryptgeon:latest
+    restart: unless-stopped
+    depends_on:
+      - memcached
+    environment:
+      SIZE_LIMIT: 4 MiB
+    networks:
+      - default
+      - proxy
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.cryptgeon.rule=Host(`cryptgeon.example.org`)
+      - traefik.http.routers.cryptgeon.entrypoints=secure
+      - traefik.http.routers.cryptgeon.tls.certresolver=le
+```
+
+**Run**
+
+```sh
+docker-compose up -d
+```
+
+## Watchtower
+
+> A container-based solution for automating Docker container base image updates.
+
+[Watchtower](https://containrrr.dev/watchtower/) will keep our containers up to date. The interval is set to once a day and also configured to delete old images to prevent cluttering.
+
+```sh
+/foo/bar/watchtower/
+└── docker-compose.yaml
+```
+
+```yaml
+# docker-compose.yaml
+
+version: '3.8'
+
+services:
+  watchtower:
+    image: containrrr/watchtower
+    restart: unless-stopped
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    command: --cleanup --interval 86400
+```

frontend/package.json

@@ -11,23 +11,25 @@
 	"type": "module",
 	"devDependencies": {
 		"@lokalise/node-api": "^7.1.1",
-		"@sveltejs/adapter-static": "^1.0.0-next.26",
-		"@sveltejs/kit": "^1.0.0-next.231",
+		"@sveltejs/adapter-static": "^1.0.0-next.28",
+		"@sveltejs/kit": "1.0.0-next.288",
 		"@types/file-saver": "^2.0.5",
+		"@types/sanitize-html": "^2.6.2",
 		"adm-zip": "^0.5.9",
 		"dotenv": "^16.0.0",
-		"svelte": "^3.46.2",
+		"svelte": "^3.46.4",
 		"svelte-check": "^2.4.5",
-		"svelte-intl-precompile": "^0.8.0",
-		"svelte-preprocess": "^4.10.1",
+		"svelte-intl-precompile": "^0.8.1",
+		"svelte-preprocess": "^4.10.4",
 		"tslib": "^2.3.1",
-		"typescript": "^4.5.4",
-		"vite": "^2.7.12"
+		"typescript": "^4.6.2",
+		"vite": "^2.8.6"
 	},
 	"dependencies": {
-		"@fontsource/fira-mono": "^4.5.0",
+		"@fontsource/fira-mono": "^4.5.3",
 		"copy-to-clipboard": "^3.3.1",
 		"file-saver": "^2.0.5",
-		"pretty-bytes": "^5.6.0"
+		"pretty-bytes": "^5.6.0",
+		"sanitize-html": "^2.7.0"
 	}
 }

frontend/src/lib/ui/ShowNote.svelte

@@ -4,11 +4,13 @@
 	import copy from 'copy-to-clipboard'
 	import { saveAs } from 'file-saver'
 	import prettyBytes from 'pretty-bytes'
+	import sanitize from 'sanitize-html'
 	import { t } from 'svelte-intl-precompile'
 	import Button from './Button.svelte'
 
 	export let note: NotePublic
 
+	const RE_URL = /[A-Za-z]+:\/\/([A-Z a-z0-9\-._~:\/?#\[\]@!$&'()*+,;%=])+/g
 	let files: FileDTO[] = []
 
 	$: if (note.meta.type === 'file') {
@@ -27,6 +29,14 @@
 		})
 		saveAs(f)
 	}
+
+	function contentWithLinks(content: string): string {
+		const replaced = note.contents.replace(
+			RE_URL,
+			(url) => `<a href="${url}" rel="noreferrer">${url}</a>`
+		)
+		return sanitize(replaced, { allowedTags: ['a'], allowedAttributes: { a: ['href', 'rel'] } })
+	}
 </script>
 
 <p class="error-text">{@html $t('show.warning_will_not_see_again')}</p>
@@ -34,6 +44,9 @@
 	<div class="note">
 		{note.contents}
 	</div>
+	<div class="note">
+		{@html contentWithLinks(note.contents)}
+	</div>
 	<Button on:click={() => copy(note.contents)}>{$t('common.copy_clipboard')}</Button>
 {:else}
 	{#each files as file}

frontend/src/routes/about.svelte

@@ -5,7 +5,6 @@
 
 	export const hydrate = dev
 	export const router = browser
-	export const prerender = true
 </script>
 
 <svelte:head>

frontend/src/routes/index.svelte

@@ -1,7 +1,3 @@
-<script context="module" lang="ts">
-	export const prerender = true
-</script>
-
 <script lang="ts">
 	import Create from '$lib/views/Create.svelte'
 </script>

frontend/svelte.config.js

@@ -9,7 +9,6 @@ export default {
 		adapter: adapter({
 			fallback: 'index.html',
 		}),
-		target: '#svelte',
 		vite: {
 			plugins: [
 				precompileIntl('locales'), // if your translations are defined in /locales/[lang].json