Note Cargo

FTP Installation

Alternatively, you can upload Note Cargo to a traditional web host using FTP.

Prerequisites

  • PHP Version: PHP 8.2 or higher recommended with SQLite module enabled
  • S3/R2 Storage: You'll need an S3-compatible Object Storage Service.
  • FTP Client: FileZilla, WinSCP, or any FTP client of your choice
⚠️ Currently only tested on Cloudflare R2, but it should work with any service that follows the S3 specification.

Installation Steps

1. Download the repo

After receiving access to the repo, download it locally.

https://github.com/note-cargo/note-cargo/archive/refs/heads/main.zip

2. Extract Files

Extract the downloaded archive or directly push to server using FTP. Extract on server is the best option, since it will upload faster since only upload one file.

3. Setup the .env

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

4. Set Directory Permissions

Make sure the following directories have write permissions (755 or 777):

  • databases/ - For SQLite cache storage

5. Optional Setup

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

6. Access Your Instance

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