cryptgeon/README.md
2021-05-02 17:14:03 +02:00

1.8 KiB

Docker pulls badge Docker image size badge Latest version

About?

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

Demo

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

Features

  • view and time constrains
  • in memory, no persistence
  • in browser encryption → server cannot decrypt contents
  • 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

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
    ports:
      - 80:5000

Development

  1. Clone
  2. run npm i in the root and and client client/ folders.
  3. Run npm 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:3000.

Attributions

Icons made by freepik from www.flaticon.com