Skip to main content

​
Get started in three steps

Set up your Sora Digital Photo Frame and start displaying your photos.

​
Step 1: Prerequisites and Installation

Ensure you have Node.js 18.0 or higher installed on your system.Check your version:
node --version
Download from nodejs.org if needed.
  1. Clone the repository:
git clone https://github.com/Sorbh/sora-digital-photo-frame.git
cd sora-digital-photo-frame
  1. Install dependencies:
npm install
The installation includes all necessary dependencies for both frontend and backend.

​
Step 2: Configuration

  1. Create a .env file in the root directory:
cp .env.example .env
  1. Configure your settings:
# Server Configuration
PORT=3000
NODE_ENV=development

# Authentication
ADMIN_PASSWORD=your_secure_password

# Upload Configuration
MAX_FILE_SIZE=10485760
UPLOAD_DIR=uploads

# Image Processing
IMAGE_QUALITY=85
MAX_RESOLUTION_WIDTH=1920
MAX_RESOLUTION_HEIGHT=1080
The default settings work great for most setups!

​
Step 3: Launch your photo frame

  1. Start the server:
npm start
  1. Open your browser and navigate to:
http://localhost:3000
  1. Your digital photo frame is now running!

​
Next steps

Now that your photo frame is running, explore these features:

Admin Panel

Upload and manage your photos with the web-based admin interface.

Keyboard Controls

Learn slideshow navigation shortcuts and controls.

Network Setup

Access your photo frame from other devices on your network.

Configuration Guide

Customize slideshow timing, image quality, and display settings.

​
Access from other devices

Network Access: To view your photo frame from tablets, phones, or other computers, replace localhost with your computer’s IP address (e.g., http://192.168.1.100:3000).

​
Troubleshooting

If port 3000 is already in use, change the PORT in your .env file:
PORT=3001
  • Ensure image files are in the correct format (JPG, PNG, GIF, WebP)
  • Check that the PHOTOS_PATH in .env points to the correct directory
  • Verify file permissions allow reading