mirror of
https://github.com/cupcakearmy/cryptgeon.git
synced 2026-09-26 20:41:45 +00:00
182 lines
11 KiB
Markdown
182 lines
11 KiB
Markdown
<p align="center">
|
||
<img src="./design/Github.png" alt="logo">
|
||
</p>
|
||
|
||
<a href="https://discord.gg/nuby6RnxZt">
|
||
<img alt="discord" src="https://img.shields.io/discord/252403122348097536?style=for-the-badge" />
|
||
<img alt="docker pulls" src="https://img.shields.io/docker/pulls/cupcakearmy/cryptgeon?style=for-the-badge" />
|
||
<img alt="Docker image size badge" src="https://img.shields.io/docker/image-size/cupcakearmy/cryptgeon?style=for-the-badge" />
|
||
<img alt="Latest version" src="https://img.shields.io/github/v/release/cupcakearmy/cryptgeon?style=for-the-badge" />
|
||
</a>
|
||
|
||
<br/><br/>
|
||
<a href="https://www.producthunt.com/posts/cryptgeon?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cryptgeon" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=295189&theme=light" alt="Cryptgeon - Securely share self-destructing notes | Product Hunt" height="50" /></a>
|
||
<a title="Install cryptgeon Raycast Extension" href="https://www.raycast.com/cupcakearmy/cryptgeon"><img src="https://www.raycast.com/cupcakearmy/cryptgeon/install_button@2x.png?v=1.1" height="64" alt="" style="height: 64px;"></a>
|
||
<br/><br/>
|
||
|
||
EN | [简体中文](README_zh-CN.md) | [ES](README_ES.md)
|
||
|
||
## About?
|
||
|
||
_cryptgeon_ is a secure, open source sharing note or file service inspired by [_PrivNote_](https://privnote.com).
|
||
It includes a server, a web page and a CLI client.
|
||
|
||
> 🌍 If you want to translate the project feel free to reach out to me.
|
||
|
||
## Live Service / Demo
|
||
|
||
### Web
|
||
|
||
Check out the live service / demo and see for yourself [cryptgeon.org](https://cryptgeon.org)
|
||
|
||
### CLI
|
||
|
||
```
|
||
npx cryptgeon send text "This is a secret note"
|
||
```
|
||
|
||
For more documentation about the CLI see the [readme](./packages/cli/README.md).
|
||
|
||
### Raycast Extension
|
||
|
||
There is an [official Raycast extension](https://www.raycast.com/cupcakearmy/cryptgeon).
|
||
|
||
<a title="Install cryptgeon Raycast Extension" href="https://www.raycast.com/cupcakearmy/cryptgeon"><img src="https://www.raycast.com/cupcakearmy/cryptgeon/install_button@2x.png?v=1.1" height="64" alt="" style="height: 64px;"></a>
|
||
|
||
## Features
|
||
|
||
- send text or files
|
||
- server cannot decrypt contents due to client side encryption
|
||
- view or time constraints
|
||
- in memory, no persistence
|
||
- obligatory dark mode support
|
||
|
||
## How does it work?
|
||
|
||
each note has a generated <code>id (256bit)</code> and <code>key 256(bit)</code>. The
|
||
<code>id</code>
|
||
is used to save & retrieve the note. the note is then encrypted with XChaCha20-Poly1305 on the
|
||
client side with the <code>key</code> and then sent to the server. data is stored in memory and
|
||
never persisted to disk. the server never sees the encryption key and cannot decrypt the contents
|
||
of the notes even if it tried to.
|
||
|
||
> View counts are guaranteed with one running instance of cryptgeon. Multiple instances connected to the same cache instance can run into race conditions, where a note might be retrieved more than the view count allows.
|
||
|
||
## Screenshot
|
||
|
||
|
||
|
||
## Environment Variables
|
||
|
||
| Variable | Default | Description |
|
||
| ----------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `CACHE` | `redis://cache/` | Cache URL (valkey or redis) to connect to. [According to format](https://docs.rs/redis/latest/redis/#connection-parameters) |
|
||
| `SIZE_LIMIT` | `1 KiB` | Max size for body. Accepted values according to [byte-unit](https://docs.rs/byte-unit/). <br> `512 MiB` is the maximum allowed. <br> Payloads are raw bytes (msgpack + cipher), so the frontend shows the full limit. |
|
||
| `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. |
|
||
| `ALLOW_FILES` | `true` | Allow uploading files. If set to `false`, users will only be allowed to create text notes. |
|
||
| `ID_LENGTH` | `32` | Set the size of the note `id` in bytes. By default this is `32` bytes. This is useful for reducing link size. _This setting does not affect encryption strength_. |
|
||
| `CACHE_PREFIX` | `""` | Optional prefix for all cache keys. Useful when sharing a cache instance with other apps via ACL namespaces. |
|
||
| `EXTRA_SIZE_LIMIT` | `512` | Maximum size in bytes of the opaque `extra` payload (e.g. key derivation params) stored on the note metadata. |
|
||
| `VERBOSITY` | `warn` | Verbosity level for the backend. [Possible values](https://docs.rs/env_logger/latest/env_logger/#enabling-logging) are: `error`, `warn`, `info`, `debug`, `trace` |
|
||
| `THEME_IMAGE` | `""` | Custom image for replacing the logo. Must be publicly reachable |
|
||
| `THEME_TEXT` | `""` | Custom text for replacing the description below the logo |
|
||
| `THEME_PAGE_TITLE` | `""` | Custom text the page title |
|
||
| `THEME_FAVICON` | `""` | Custom url for the favicon. Must be publicly reachable |
|
||
| `THEME_NEW_NOTE_NOTICE` | `true` | Show the message about how notes are stored in the memory and may be evicted after creating a new note. Defaults to `true`. |
|
||
| `THEME_HOME_LINK` | `true` | Show the `/home` link in the footer. Defaults to `true`. |
|
||
| `IMPRINT_URL` | `""` | Custom url for an Imprint hosted somewhere else. Must be publicly reachable. Takes precedence above `IMPRINT_HTML`. |
|
||
| `IMPRINT_HTML` | `""` | Alternative to `IMPRINT_URL`, this can be used to specify the HTML code to show on `/imprint`. Only `IMPRINT_HTML` or `IMPRINT_URL` should be specified, not both. |
|
||
|
||
## Deployment
|
||
|
||
> ℹ️ `https` is required otherwise browsers will not support the cryptographic functions.
|
||
|
||
> ℹ️ There is a health endpoint available at `/healthz`. It returns either 200 or 503.
|
||
|
||
### Docker
|
||
|
||
Docker is the easiest way. There is the [official image here](https://hub.docker.com/r/cupcakearmy/cryptgeon).
|
||
|
||
```yaml
|
||
# docker-compose.yml
|
||
|
||
services:
|
||
cache:
|
||
image: valkey/valkey:7-alpine
|
||
# This is required to stay in RAM only.
|
||
command: valkey-server --save "" --appendonly no
|
||
# Set a size limit. See link below on how to customise.
|
||
# https://valkey.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
|
||
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
|
||
# This prevents the creation of an anonymous volume.
|
||
tmpfs:
|
||
- /data
|
||
|
||
app:
|
||
image: cupcakearmy/cryptgeon:latest
|
||
depends_on:
|
||
- cache
|
||
environment:
|
||
# Size limit for a single note.
|
||
SIZE_LIMIT: 4 MiB
|
||
ports:
|
||
- 80:8000
|
||
|
||
# Optional health checks
|
||
# healthcheck:
|
||
# test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/healthz"]
|
||
# interval: 1m
|
||
# timeout: 3s
|
||
# retries: 2
|
||
# start_period: 5s
|
||
```
|
||
|
||
### NGINX Proxy
|
||
|
||
See the [examples/nginx](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/nginx) folder. There an example with a simple proxy, and one with https. You need to specify the server names and certificates.
|
||
|
||
### Traefik 2
|
||
|
||
See the [examples/traefik](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/traefik) folder.
|
||
|
||
### Scratch
|
||
|
||
See the [examples/scratch](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/scratch) folder. There you'll find a guide how to setup a server and install cryptgeon from scratch.
|
||
|
||
### Synology
|
||
|
||
There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-synology-nas/) you can follow.
|
||
|
||
### YouTube Guides
|
||
|
||
- English by [Webnestify](https://www.youtube.com/watch?v=XAyD42I7wyI)
|
||
- English by [DB Tech](https://www.youtube.com/watch?v=S0jx7wpOfNM) [Previous Video](https://www.youtube.com/watch?v=JhpIatD06vE)
|
||
- German by [ApfelCast](https://www.youtube.com/watch?v=84ZMbE9AkHg)
|
||
|
||
### Written Guides
|
||
|
||
- French by [zarevskaya](https://belginux.com/installer-cryptgeon-avec-docker/)
|
||
- Italian by [@nicfab](https://notes.nicfab.eu/it/posts/cryptgeon/)
|
||
- English by [@nicfab](https://notes.nicfab.eu/en/posts/cryptgeon/)
|
||
|
||
## Contributing
|
||
|
||
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
||
|
||
## Security
|
||
|
||
Please refer to the security section [here](./SECURITY.md).
|
||
|
||
---
|
||
|
||
_Attributions_
|
||
|
||
- Test data:
|
||
- Text for tests [Nietzsche Ipsum](https://nietzsche-ipsum.com/)
|
||
- [AES Paper](https://www.cs.miami.edu/home/burt/learning/Csc688.012/rijndael/rijndael_doc_V2.pdf)
|
||
- [Unsplash Pictures](https://unsplash.com/)
|
||
- Loading animation by [Nikhil Krishnan](https://codepen.io/nikhil8krishnan/pen/rVoXJa)
|
||
- 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>
|