Skip to main content

Installation

Step-by-step installation guide for TMA Cloud.

Installation Options​

TMA Cloud can be installed in two ways:

  1. Docker Compose (Recommended) - Use the project's docker-compose.yml for the easiest setup
  2. Manual Installation - Build and run from source (see below)

For full Docker options (prebuilt images, build from source), see the Docker Setup Guide.

Download docker-compose.yml and .env.example with curl—no need to clone the repo.

Docker-Compose Prerequisites​

Steps​

Create a directory and download the files

mkdir tma-cloud && cd tma-cloud
curl -sSL -o docker-compose.yml https://raw.githubusercontent.com/TMA-Cloud/TMA/main/docker-compose.yml
curl -sSL -o .env.example https://raw.githubusercontent.com/TMA-Cloud/TMA/main/.env.example

Configure environment

cp .env.example .env
# Edit .env with your configuration.

Start all services

docker compose up -d

This starts: app (main API), postgres, redis, and worker (audit processor). Access at http://localhost:3000 (or your BPORT).

Verify

docker compose ps
docker compose logs -f

For more Docker options (prebuilt images, building from source, volumes, etc.), see Docker Deployment.

Option 2: Manual Installation​

Manual-Installation Prerequisites​

  • Node.js (v25+)
  • PostgreSQL (v17+)
  • Redis (v6+) - Optional but recommended
  • npm or yarn

Installation Steps​

1. Clone Repository​

git clone https://github.com/TMA-Cloud/TMA.git
cd TMA

2. Backend Setup​

cd backend
npm install
cp ../.env.example ../.env
# Edit ../.env with your configuration

Required variables:

  • JWT_SECRET - Secret key for JWT tokens
  • DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME - Database connection
  • REDIS_HOST, REDIS_PORT - Redis connection (optional)
  • BPORT - Backend port (default: 3000)
  • UPLOAD_DIR - Upload directory

Optional:

  • GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GOOGLE_REDIRECT_URI - Google OAuth
  • BACKEND_URL - Public backend URL (for OnlyOffice)

3. Create Database​

CREATE DATABASE cloud_storage;

Migrations run automatically on startup.

4. Setup Redis (Optional)​

Linux/macOS:

# Ubuntu/Debian
sudo apt-get install redis-server

# macOS
brew install redis
brew services start redis

redis-server

Windows: Use Docker or WSL

Verify: redis-cli ping (should return PONG)

5. Frontend Setup​

cd ../frontend
npm install
npm run build

6. Start Application​

Production:

# Terminal 1 - Backend
cd backend
npm start

# Terminal 2 - Audit Worker (required)
cd backend
npm run worker

Access at http://localhost:3000

Development:

# Terminal 1 - Backend
cd backend
npm run dev

# Terminal 2 - Frontend
cd frontend
npm run dev

Access at http://localhost:5173

Verification​

  1. Backend shows: "Database connected successfully", "Server running on port 3000"
  2. Open browser: http://localhost:3000 (production) or http://localhost:5173 (development)
  3. Create first account (becomes admin)

Troubleshooting​

Database: Verify PostgreSQL is running, check credentials in .env

Redis: Verify with redis-cli ping. App works without Redis but caching is disabled.

Port: Change BPORT in .env if port is in use

OnlyOffice: Configure via Settings page (admin-only). Requires BACKEND_URL environment variable.

Audit Worker: Must run npm run worker in production. See Audit Logs Documentation.

Next Steps​