cupcakearmy/cryptgeon
1
0
Fork 0
mirror of https://github.com/cupcakearmy/cryptgeon.git synced 2024-12-22 08:16:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
cryptgeon is a secure, open source note / file sharing service inspired by PrivNote written in rust & svelte.
101 Commits 1 Branch 50 Tags 21 MiB
Svelte 44%
TypeScript 31.5%
Rust 13.5%
JavaScript 7.7%
CSS 2.3%
Other 1%
aea85c3b73
Go to file
cupcakearmy aea85c3b73
env docs
2021-12-20 17:42:35 +01:00
.github 1.2.0 2021-11-11 13:37:21 +01:00
.vscode editor 2021-05-02 03:08:43 +02:00
client pnpm 2021-12-20 17:41:03 +01:00
design use svg as text 2021-05-07 12:14:07 +02:00
src middleware to handle json payloads 2021-12-20 17:42:16 +01:00
.dockerignore bug 2021-05-08 10:16:05 +02:00
.gitattributes move svg from lfs to repo 2021-05-02 16:24:31 +02:00
.gitignore scripts 2021-05-02 15:44:42 +02:00
Cargo.lock cargo file 2021-12-20 17:42:30 +01:00
Cargo.toml cargo file 2021-12-20 17:42:30 +01:00
CHANGELOG.md 1.2.0 2021-11-11 13:37:21 +01:00
cypress.json config 2021-05-10 10:04:19 +02:00
docker-compose.yml cypress runner 2021-05-10 09:58:21 +02:00
Dockerfile 1.2.0 2021-11-11 13:37:21 +01:00
LICENSE Create LICENSE 2021-05-02 12:13:13 +02:00
package.json pnpm 2021-12-20 17:41:03 +01:00
pnpm-lock.yaml 1.2.0 2021-11-11 13:37:21 +01:00
README.md env docs 2021-12-20 17:42:35 +01:00

README.md

logo

discord docker pulls Docker image size badge Latest version
Cryptgeon - Securely share self-destructing notes | Product Hunt

About?

cryptgeon is a secure, open source sharing note service inspired by PrivNote

Demo

Check out the demo and see for yourself https://cryptgeon.nicco.io.

Features

  • server cannot decrypt contents due to client side encryption
  • view and time constraints
  • in memory, no persistence
  • obligatory dark mode support

How does it work?

each note has a 512bit generated id that is used to retrieve the note. data is stored in memory and never persisted to disk.

Screenshot

screenshot

Deployment

ℹ️ https is required otherwise browsers will not support the cryptographic functions.

Docker is the easiest way. There is the official image here.

# docker-compose.yml

version: '3.7'

services:
  memcached:
    image: memcached:1-alpine
    entrypoint: memcached -m 128 # Limit to 128 MB Ram, customize at free will.

  app:
    image: cupcakearmy/cryptgeon:latest
    depends_on:
      - memcached
    ports:
      - 80:5000

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

Development

  1. Clone
  2. run pnpm i in the root and and client client/ folders.
  3. Run pnpm run dev to start development.

Running npm run dev in the root folder will start the following things

  • a memcache docker container
  • rust backend with hot reload
  • client with hot reload

You can see the app under localhost:5000.

Attributions

Icons made by freepik from www.flaticon.com