Skip to content

Latest commit

 

History

History
333 lines (222 loc) · 9.73 KB

README.md

File metadata and controls

333 lines (222 loc) · 9.73 KB
Raw

Onetime Secret - v0.16.2

Keep passwords and other sensitive information out of your inboxes and chat logs.

Latest releases

What is a Onetime Secret?

A onetime secret is a link that can be viewed only once. A single-use URL.

Try it out on OnetimeSecret.com!

Why would I want to use it?

When you send people sensitive info like passwords and private links via email or chat, there are copies of that information stored in many places. If you use a Onetime link instead, the information persists for a single viewing which means it can't be read by someone else later. This allows you to send sensitive information in a safe way knowing it's seen by one person only. Think of it like a self-destructing message.

Installation

System Requirements

  • Any recent linux disto (we use debian) or *BSD
  • System dependencies:
    • Ruby 3.2, 3.1, 3.0, 2.7.8
    • Redis server 5+
  • Minimum specs:
    • 2 core CPU (or equivalent)
    • 1GB memory
    • 4GB disk

For front-end development, you'll also need:

  • Node.js 18+
  • pnpm 7.0.0+

Docker

Running from a container is the easiest way to get started. We provide a Dockerfile that you can use to build your own image, or you can use one of the pre-built images from our container repositories.

  # Install from the GitHub Container Registry
  $ docker pull ghcr.io/onetimesecret/onetimesecret:latest

  # OR, install from Docker Hub

  $ docker pull onetimesecret/onetimesecret:latest

  # Start redis container
  $ docker run -p 6379:6379 -d redis:bookworm

  # Set essential environment variables
  HOST=localhost:3000
  SSL=false
  COLONEL=admin@example.com
  REDIS_URL=redis://host.docker.internal:6379/0
  RACK_ENV=production

  # Create and run a container named `onetimesecret`
  $ docker run -p 3000:3000 -d --name onetimesecret \
      -e REDIS_URL=$REDIS_URL \
      -e COLONEL=$COLONEL \
      -e HOST=$HOST \
      -e SSL=$SSL \
      -e RACK_ENV=$RACK_ENV \
      onetimesecret/onetimesecret:latest

Building image locally

  $ docker build -t onetimesecret .
  $ docker run -p 3000:3000 -d --name onetimesecret \
      -e REDIS_URL=$REDIS_URL \
      -e COLONEL=$COLONEL \
      -e HOST=$HOST \
      -e SSL=$SSL \
      -e RACK_ENV=$RACK_ENV \
      onetimesecret

Optional Bundle Install

By default, the bundle install command is not run when starting the container. If you want it to run at startup (e.g., to re-install new dependencies added to the Gemfile without rebuilding the image), you can set the BUNDLE_INSTALL environment variable to true. Here's how you can do this:

$ docker run -p 3000:3000 -d --name onetimesecret \
    -e BUNDLE_INSTALL=true \
    -e REDIS_URL=$REDIS_URL \
    -e COLONEL=$COLONEL \
    -e HOST=$HOST \
    -e SSL=$SSL \
    -e RACK_ENV=$RACK_ENV \
    onetimesecret/onetimesecret:latest

This will cause the container to run bundle install each time it starts up. Note that this may increase the startup time of your container.

Multi-platform builds

Docker's buildx command is a powerful tool that allows you to create Docker images for multiple platforms simultaneously. Use buildx to build a Docker image that can run on both amd64 (standard Intel/AMD CPUs) and arm64 (ARM CPUs, like those in the Apple M1 chip) platforms.

  $ docker buildx build --platform=linux/amd64,linux/arm64 . -t onetimesecret

"The container name "/onetimesecret" is already in use"

  # If the container already exists, you can simply start it again:
  $ docker start onetimesecret

  # OR, remove the existing container
  $ docker rm onetimesecret

After the container has been removed, the regular docker run command will work again.

Container repositories

GitHub Container Registry
  $ docker run -p 6379:6379 --name redis -d redis
  $ REDIS_URL="redis://172.17.0.2:6379/0"

  $ docker pull ghcr.io/onetimesecret/onetimesecret:latest
  $ docker run -p 3000:3000 -d --name onetimesecret \
    -e REDIS_URL=$REDIS_URL \
    ghcr.io/onetimesecret/onetimesecret:latest
Docker Hub
  $ docker run -p 6379:6379 --name redis -d redis
  $ REDIS_URL="redis://172.17.0.2:6379/0"

  $ docker pull onetimesecret/onetimesecret:latest
  $ docker run -p 3000:3000 -d --name onetimesecret \
    -e REDIS_URL=$REDIS_URL \
    onetimesecret/onetimesecret:latest

Docker Compose

See the dedicated Docker Compose repo.

Manually

Get the code, one of:

  $ git clone https://github.com/onetimesecret/onetimesecret.git

For a fresh install

If you're installing on a fresh system, you'll need to install a few system dependencies before you can run the webapp.

0. Install system dependencies

The official Ruby docs have a great guide on installing Ruby. Here's a quick guide for Debian/Ubuntu:

For Debian / Ubuntu:

  # Make sure you have the latest packages (even if you're on a fresh install)
  $ sudo apt update

  # Install the basic tools of life
  $ sudo apt install -y git curl sudo

  # Install Ruby (3) and Redis
  $ sudo apt install -y ruby-full redis-server

NOTE: The redis-server service should start automatically after installing it. You can check that it's up by running: service redis-server status. If it's not running, you can start it with service redis-server start.

1. Now get the code via git:

  $ git clone https://github.com/onetimesecret/onetimesecret.git

2. Copy the configuration files into place and modify as needed:

  $ cd onetimesecret

  $ cp --preserve --no-clobber ./etc/config.example ./etc/config
  $ cp --preserve --no-clobber .env.example .env

3. Install ruby dependencies

  # We use bundler manage the rest of the ruby dependencies
  $ sudo gem install bundler

  # Install the rubygems listing inthe Gemfile
  $ bundle install

4. Install javascript dependencies

  $ pnpm install

And build the assets:

  $ pnpm run build

5. Run the webapp

  $ bundle exec thin -R config.ru -p 3000 start

  ---  ONETIME app  ----------------------------------------
  Config: /Users/d/Projects/opensource/onetimesecret/etc/config
  2024-04-10 22:39:15 -0700 Thin web server (v1.8.2 codename Ruby Razor)
  2024-04-10 22:39:15 -0700 Maximum connections set to 1024
  2024-04-10 22:39:15 -0700 Listening on 0.0.0.0:3000, CTRL+C to stop

See the Ruby CI workflow for another example of the steps.

In a separate terminal window, run the Vite dev server:

  $ pnpm run dev

NOTE: When running the Vite server in development mode, it will automatically reload when files change. Make sure that RACK_ENV is either set to development or development.enabled in etc/config is false. Otherwise the ruby application will attempt to lad the JS/CSS etc from the pre-built files in public/web/dist.

Debugging

To run in debug mode set ONETIME_DEBUG=true.

  $ ONETIME_DEBUG=true bundle exec thin -e dev start`

If you're having trouble cloning via SSH, you can double check your SSH config like this:

With a github account

  ssh -T git@github.com
  Hi delano! You've successfully authenticated, but GitHub does not provide shell access.

Without a github account

  ssh -T git@github.com
  Warning: Permanently added the RSA host key for IP address '0.0.0.0/0' to the list of known hosts.
  git@github.com: Permission denied (publickey).

NOTE: you can also use the etc directory from here instead of copying it to the system. Just be sure to secure the permissions on it

  chown -R ots ./etc
  chmod -R o-rwx ./etc

Configuration

  1. ./etc/config
  • Update your secret key
    • Back up your secret key (e.g. in your password manager). If you lose it, you won't be able to decrypt any existing secrets.
  • Update the SMTP or SendGrid credentials for email sending
    • Update the from address (it's used for all sent emails)
  • Update the rate limits at the bottom of the file
    • The numbers refer to the number of times each action can occur for unauthenticated users.
  • Enable or disable the available locales.
  1. ./etc/redis.conf
  • The host, port, and password need to match
  1. /etc/onetime/locale/*
  • Optionally you can customize the text used throughout the site and emails
  • You can also edit the :broadcast string to display a brief message at the top of every page

Running

There are many ways to run the webapp. The default web server we use is thin. It's a Rack app so any server in the ruby ecosystem that supports Rack apps will work.

To run locally:

  bundle exec thin -e dev -R config.ru -p 3000 start

To run on a server:

  bundle exec thin -d -S /var/run/thin/thin.sock -l /var/log/thin/thin.log -P /var/run/thin/thin.pid -e prod -s 2 start

Graceful restart:

  bundle exec thin --onebyone -d -S /var/run/thin/thin.sock -l /var/log/thin/thin.log -P /var/run/thin/thin.pid -e prod -s 4 -D restart

Generating a global secret

We include a global secret in the encryption key so it needs to be long and secure. One approach for generating a secret:

  dd if=/dev/urandom bs=20 count=1 | openssl sha256