sup3rS3cretMes5age

(β˜… 568)

Simple to use, simple to deploy, one time self destruct messaging service, with hashicorp vault as a backend

  • .codacy.yml
  • .dockerignore
  • .gitignore
  • .golangci.yml
  • AWS_DEPLOYMENT.md
  • CLI.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • go.mod
  • go.sum
  • LICENSE
  • Makefile
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/algolia/sup3rS3cretMes5age

Downloads the entire project code from GitHub to your computer.

cd sup3rS3cretMes5age

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -d --name vault-dev -p 8200:8200 \

Runs the built image as an actual container.

docker compose -f deploy/docker-compose.yml up --build -d

Runs the command against the services defined in the compose file.

β”‚ β”œβ”€β”€ docker-compose.yml # Local dev stack

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build -o sup3rs3cret cmd/sup3rS3cretMes5age/main.go

Compiles the Go program into an executable.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make run

Compiles the code based on the generated build configuration to produce an executable.

make run # Start services (Vault + App)

Compiles the code based on the generated build configuration to produce an executable.

make logs # View logs

Compiles the code based on the generated build configuration to produce an executable.

make stop # Stop services

Compiles the code based on the generated build configuration to produce an executable.

make clean # Remove containers

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation