Note Cargo

Docker Installation

The most robust way to deploy Note Cargo is using Docker.

Prerequisites

  • Docker: Make sure Docker and Docker Compose is installed on your system
  • S3/R2 Storage: You'll need an S3-compatible Object Storage Service.
⚠️ Currently only tested on Cloudflare R2, but it should work with any service that follows the S3 specification.

Installation Steps

1. Clone the repo

After receiving access to the repo, clone it locally.

git clone https://github.com/note-cargo/note-cargo.git

2. Setup the .env

Copy a .env.example to .env and adjust based on your object storage config. You also need to setup the username and password.

3. Run the Container

docker compose up

If you want to run it on the background/detached just add -d at the end of command.

docker compose up -d

4. Optional Setup

Your note-taking app already ready, but to be able to use more features like Search, you need to enable Background Indexing.

5. Access Your Instance

Open your browser and navigate to http://localhost:8080 to access the UI.