kanna/readme.md

103 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2022-09-27 20:08:48 +02:00
# kanna
2022-10-17 19:22:28 +02:00
![salt](/docs/src/salt.png)
2022-10-04 22:06:22 +02:00
because the internet needs rewriting
security project to ~~learn client and server encryption~~ mail & advanced requests
2022-10-04 16:50:21 +02:00
2022-10-11 18:10:19 +02:00
## hosting
### initial (needed) files
create generic keys `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./certs/selfsigned.key -out ./certs/selfsigned.crt`, or insert which ever ones to `./certs/selfsigned.key` and to `./certs/selfsigned.crt` respectively
2022-11-01 19:10:27 +01:00
***
2022-10-11 18:10:19 +02:00
### running
dependencies:
2022-11-01 19:10:27 +01:00
* ts-node |`npm i -g ts-node`
* package.json | `npm i`
* development (optional)
* nodemon | `npm i -g nodemon`
2022-10-31 15:56:36 +01:00
#### windows
2022-09-27 20:08:48 +02:00
2022-10-31 15:56:36 +01:00
main build : `npm start`
dev : `npm run dev`
2022-09-27 20:08:48 +02:00
2022-11-01 19:10:27 +01:00
***
2022-10-11 18:10:19 +02:00
#### \*nix
2022-10-31 15:56:36 +01:00
###### please note, for linux you will need to run this as root (for permission to use these ports, 80,443)
2022-10-11 18:10:19 +02:00
2022-10-31 15:56:36 +01:00
main build : `sudo ts-node .`
2022-10-11 18:10:19 +02:00
2022-10-31 15:56:36 +01:00
dev : `sudo nodemon .`
2022-10-11 18:10:19 +02:00
2022-11-01 19:10:27 +01:00
***
2022-09-30 09:41:50 +02:00
2022-10-31 15:56:36 +01:00
[gitea](https://git.disroot.org/grantsquires/kanna-site) | [github](https://github.com/squiresgrant/kanna-site)
2022-10-04 14:44:26 +02:00
## todo
2022-11-01 19:10:27 +01:00
* \[ ] add extra pages
* \[ ] home page (quick links, etc)
* \[ ] mail
* \[ ] allow for automation (ie, auto reply)
* \[ ] forums
* \[ ] storage
* \[ ] viewer for images
* \[ ] viewer for docs
* \[ ] login
* \[ ] performance related
* \[ ] store all listeners in array and kill
* \[ ] go through all html files, clean up code
* \[ ] increase initiation vector (IV) size
2022-10-04 22:06:22 +02:00
## currently
2022-11-01 19:10:27 +01:00
* \[x] learning how mail works
* \[ ] toggle plaintext/html emails
* \[ ] option to markdownify email
* \[ ] write md emails, send as html
* \[ ] sexify
* \[ ] settings.json
* \[ ] make mail prettier
* \[ ] dont accept old login keys
* \[ ] add functionality
* \[x] loading screen
* \[x] storage for quicker (initial)loading
* \[x] delete
* \[ ] send
* \[ ] reply
* \[ ] draft
* \[ ] forward
* \[ ] sender info
* \[ ] allow for email account adding
* \[ ] docs
* \[x] extra pages
* \[x] 404 page
* \[ ] sub domains
* \[ ] ughh hate sub domains
* \[ ] make my own libs
* \[ ] encryption (md5 hashing, rsa, and aes)
* \[ ] [imap wrapper (soonish)](https://www.nylas.com/blog/nylas-imap-therefore-i-am/)
* \[ ] add aliases that are used in cookies and randomly gen.
* \[ ] also server side hash to check/verify the alias
* \[ ] more sexy gradients (everywhere)
* \[ ] lower verbosity (and options to change it)
* \[ ] move all dependencies to local ones
* \[ ] check for permissions on what ports to open
### issues
* \[x] storage not saving
* \[ ] check for login key cookie on page load
2022-10-07 20:44:38 +02:00
FeMail (iron mail)