cryptgeon/README.md

50 lines
1.0 KiB
Markdown
Raw Normal View History

2021-05-02 14:40:06 +02:00
<p align="center">
2021-05-02 14:54:57 +02:00
<img src="./design/github.svg">
2021-05-02 14:40:06 +02:00
</p>
2021-05-01 12:40:02 +02:00
2021-05-02 14:40:06 +02:00
## About?
_cryptgeon_ is an secure, open source sharing note service inspired by [_PrivNote_](https://privnote.com)
2021-05-02 15:24:19 +02:00
## Demo
Check out the demo and see for yourself https://cryptgeon.nicco.io.
2021-05-02 14:40:06 +02:00
## Features
- view and time constrains
- in memory, no persistence
- in browser encryption → server cannot decrypt contents
## How does it work?
each note has a 512bit generated <i>id</i> that is used to retrieve the note. data is stored in memory and never persisted to disk.
2021-05-02 15:12:04 +02:00
## Screenshot
![screenshot](./design/screen.jpg)
2021-05-02 14:40:06 +02:00
## Deployment
Docker is the easiest way.
```yaml
# docker-compose.yml
version: '3.7'
services:
memcached:
image: memcached:1-alpine
2021-05-02 14:54:57 +02:00
entrypoint: memcached -m 128 # Limit to 128 MB Ram, customize at free will.
2021-05-02 14:40:06 +02:00
app:
image: cupcakearmy/cryptgeon:latest
ports:
- 80:5000
```
###### Attributions
Icons made by <a href="https://www.freepik.com" title="Freepik">freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>