各大云盘空间的客户端程序Nimbus

 

Nimbus cloud storage

The future of file storage

nimbus.storage

A better cloud

Quickstart

Prerequisites

• Bun (JavaScript runtime)
• Docker (for running PostgreSQL)
• Git
• OpenSSL

1. Clone the Repository

git clone https://github.com/nimbusdotstorage/Nimbus
cd Nimbus

2. Install Dependencies

bun i

3. Environment Setup

1. Copy .env.example to .env

cp .env.example .env

Copy .env to child directories

bun run env:sync

Follow the instructions on the first step of this guide.

How to setup Google keys?

• 
  

• 
  

• • 
    
  • 
    
  • 
    

• • 
    
  • 
    
  • 
    
  • 
    
  • 
    

• • 
    
  • 
    

• 
  

How to setup Microsoft keys?

• 
  

• • 
    
  • 
    
  • 
    

• 
  

• 
  

• 
  

• • 
    
  • 
    
  • 
    
  • 
    
  • 
    
  • 
    

• 
  

How to setup Box keys?

• 
  

• 
  

• • 
    
  • 
    
  • 
    
  • 
    
  • 
    
  • 
    
  • 
    

• 
  

• 
  

• • 
    
  • 
    
  • 
    
  • 
    

• 
  

• 
  

Details

• 
  

• • 
    
  • 
    
  • 
    

• 
  

• 
  

• • 
    
  • 
    
  • 
    
  • 
    
  • 
    

• 
  

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

MICROSOFT_CLIENT_ID=
MICROSOFT_CLIENT_SECRET=

BOX_CLIENT_ID=
BOX_CLIENT_SECRET=

# To generate a secret, just run `openssl rand -base64 32`
BETTER_AUTH_SECRET=

How to get a Resend API Key?

1. 
   

2. 
   

3. 
   

4. 
   

5. 
   

6. 
   

RESEND_API_KEY=your-api-key-here

4. Set Up Postgres and Valkey with Docker

We use Docker to run a PostgreSQL database and Valkey for local development. Follow these steps to set it up:

1. Start the database and valkey:

   bun db:up
   bun cache:up

2. You should see the nimbus-db and nimbus-cache containers in the list with a status of "Up".

3. Run Database Migrations

After setting up the database, run the migrations:

bun db:push

Connect to the valkey (optional):

# Using valkey-cli inside the container
docker compose exec valkey valkey-cli --user valkey --pass valkey

7. Start the Development Server

In a new terminal, start the development server:

NOTE: this starts both the web and server development servers, to run just one, use bun dev:web or bun dev:server. Both will need the db running to work.

bun dev

The application should now be running at http://localhost:3000

8. Access Authentication

Once the development server is running, you can access the authentication pages:

• Sign In: Navigate to http://localhost:3000/signin
• Sign Up: Navigate to http://localhost:3000/signup

Make sure you have configured the Google OAuth credentials in your .env file as described in step 4 for authentication to work properly. Additionally, configure your Resend API key for the forgot password functionality to work.

If you want to contribute, please refer to the contributing guide

Deploying Docker images (ex. Coolify)

Follow the DEPLOYMENT.md file for instructions on how to deploy with Coolify.

Deploying Nimbus to VPS/VDS for Production or Development

Deployment is the same locally or on a server, but OAuth providers (e.g., Google) require a domain for callback URLs.

Steps to Deploy on a Server:

1. Point your domain to the server.
2. Use the domain in Google API keys for callback URLs (e.g., https://example.com:1284/api/auth/callback/google).
3. Update the .env file with the domain (e.g., TRUSTED_ORIGINS=https://example.com:3000).

This will start a Postgres container with default credentials:

• Host: localhost
• Port: 5432
• Database: nimbus
• Username: postgres
• Password: postgres

And a Valkey container with credentials:

• Host: localhost
• Port: 6379
• Username: valkey
• Password: valkey

Verify the database and valkey is running if running a detached container:

docker ps

Connect to the database (optional):

# Using psql client inside the container
docker compose exec postgres psql -U postgres -d nimbus

from  https://github.com/nimbusdotstorage/Nimbus