Git Product home page Git Product logo

hidden-room's Introduction

Hidden Room

Hidden Room

Web-based anonymous live chat app and file sharing.

Initial Setup

# install dependencies
# this is not required if you just want to use container
npm i

# generate server/key.ts
npm run gen

Developing

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

# build sveltekit
npm run build:app

# build server
npm run build:server

# build both
npm run build

Runing the Server

To run the server

# run server without tor
npm run serve

Container

# generate necessary files for containerization
npm run deploy:prepare
Docker
# add executable permission
chmod +x docker.sh

# run the script
./docker.sh
Podman
# add executable permission
chmod +x podman.sh

# run the script
./podman.sh

Deployment

Hidden Room was meant to be a hidden service. For easy deployment it includes tor image builder that is located in tor directory ๐Ÿ“, it will also generate docker-compose.yaml so it can easily be deployed using container orchestrator like docker-compose or podman-compose

when you run

npm run deploy:prepare

it will generate Dockerfile, docker.sh, podman.sh, docker-compose.yaml and tor/torrc. Check if those files are properly generated.

however if you have either file or directory named service in tor directory it will also generate tor/Dockerfile.custom and docker-compose.custom.yaml

if tor/service is a directory it will copy the content inside that directory into /var/lib/tor/hidden_room inside tor image, it should contains hostname, hs_ed25519_public_key, hs_ed25519_secret_key files.

and if tor/service is a file it will try to create custom onion address based on the text inside that file (keep in mind the longer the prefix the more time is required to build tor image, 4 or less characters would be fine). if there is no text inside that file it will use "room" as prefix

if everything is ready, simply run

# docker-compose
docker-compose up -d

# podman-compose
podman-compose up -d

and if you want to use your custom onion address

# docker
docker-compose -f docker-compose.custom.yaml up -d

# podman
podman-compose -f docker-compose.custom.yaml up -d

to see your onion address

# docker
docker exec tor list-services

# podman
docker exec tor list-services

check the address using Tor Browser and see if it's running


TODO

Server

  • http2 server

Client

  • file type icons
  • file signature-based file type detection

Container

  • firewall for tor image

hidden-room's People

Contributors

fmented avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.