Skip to content

Commit

Permalink
Merge branch 'master' into docker-build
Browse files Browse the repository at this point in the history
  • Loading branch information
@colloqi
colloqi committed Jan 10, 2024
2 parents dda7732 + f08f883 commit 90a327d
Show file tree
Hide file tree
Showing 5 changed files with 166 additions and 139 deletions.
142 changes: 71 additions & 71 deletions README.md
View file
Expand Up @@ -2,25 +2,26 @@

Server code to manage piSignage players in a LAN or Private Network or to setup your own server!

run npm install command after git pull and before starting the server
Run the `npm install` command after `git pull` and before starting the server

## Docker image available - beta
- Install docker from https://docs.docker.com/get-docker/
- Install git if needed & issue `git clone https://github.com/colloqi/pisignage-server`
OR
- Install git if needed & issue `git clone https://github.com/colloqi/pisignage-server`

OR

just get the file https://raw.githubusercontent.com/colloqi/pisignage-server/master/docker-compose.yml
- docker-compose up -d
- `docker compose up -d`
- Use the url http://localhost:3000 to launch web application
- To generate your own Docker image, please goto docker-build branch and modify Dockerfile. Also use docker-compose.prod.yml
- Default credentials: Username:Password = `pi:pi`
- To generate your own Docker image, please goto docker-build branch and modify Dockerfile. Also use `docker-compose.prod.yml`


#### Changes to Docker application from server code (it is built in docker-build brnach and you could watch the different as well Dockerfile there)
1. media and data dir are docker volumes (instead of ../media and ./data)
2. in config/end/production.js: https is false and port is 3000, db is changed to pisignage-server-dev for compatibility and mongo network is changed from 127.0.0.1 to mongo)

## Recommended Server configuration
## Recommended Server configuration
- Intel CPU based VM or server
- 2GB minimum memory
- 30GB+ SSD or hard disk
Expand All @@ -34,7 +35,7 @@ Server code to manage piSignage players in a LAN or Private Network or to setup
3. Apply your code changes if any
4. rm package-lock.json
5. rm -rf node_modules (entire directory and its contents)
6. Do "npm install"
6. Do "npm install"
7. Start the pisignage-server and go to url localhost:3000
8. Enter the username of yours at pisignage.com (not the email ID) (or change under settings, otherwise player license will not be enabled)
9. Default authentication credentials for player webUI has been changed to pi:pi
Expand All @@ -46,53 +47,52 @@ Server code to manage piSignage players in a LAN or Private Network or to setup
## Getting Started


Note: Instructions may change, please refer to the respective package/OS websites for the latest,
Note: Instructions may change, please refer to the respective package/OS websites for the latest,
Write to us at support@pisignage.com for help.


1. Install mongodb - open-source document database

Refer mongodb install guides to install mongodb.
Refer mongodb install guides to install mongodb.

- Windows: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/
- Linux: https://docs.mongodb.com/manual/administration/install-on-linux/
- Mac OS X: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/
- Mac OS X: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/

2. Install node.js and npm - open source server framework

https://nodejs.org/en/download/package-manager/

3. Install ffmpeg - video converter

https://www.ffmpeg.org/download.html


4. Install imagemagick - tool for image edit, conversion

https://www.imagemagick.org/script/download.php

5. Install Git - distributed version control system

https://git-scm.com/downloads

5. Clone this reporsitory and run follwing commands
5. Clone this repository and run the following commands

- git clone https://github.com/colloqi/pisignage-server
- git clone https://github.com/colloqi/pisignage-server
- mkdir media
- mkdir media/_thumbnails
- cd pisignage-server
- npm install

6. Currently network port is configured as 3000 in local server. Modify in the file `config/env/development.js` for the port

7. Run node server with `node server.js`

8. Open Chrome browser and check at [http://localhost:3000](http://localhost:3000) **OR** `http://[your-ip]:3000` (ex: 192.168.1.30:3000, 10.50.16.110:3000)

9. Do the following configuration before you start
- Under settings, configure the username to be same as that of your signin username at pisignage.com (it is **not** your email id)
- Download the license files either from email or from pisignage.com, upload them to your local server under settings
- You can upgrade your players directly from your local server
9. Do the following configuration before you start
- Under settings, configure the username to be same as that of your signin username at pisignage.com (it is **not** your email id)
- Download the license files either from email or from pisignage.com, upload them to your local server under settings
- You can upgrade your players directly from your local server
- authentication is pi & pi, you can change this under settings

**NOTE:** Please make sure **mongod** process is running and **/data/db** owenership is changed to regular user. If not use, ``` sudo chown -R your-username:user-group /data```
Expand All @@ -102,65 +102,65 @@ Server code to manage piSignage players in a LAN or Private Network or to setup

1. Download the pisignage player software and prepare SD card as per [instructions](https://github.com/colloqi/piSignage#method-1-download-image-and-prepare-the-sd-card)

2. After player boots, configure admin and media server to your local address and port using one of the below methods
2. After player boots, configure admin and media server to your local address and port using one of the below methods

a. Using the webUI of the player at http://[player IP]:8000/settings
b. Connect Keyboard and press Ctrl-N or F6
* Change config and media server to `http://[your server ip]:port` (ex: 192.168.1.30:3000, 10.50.16.110:3000)
* Open terminal `ctrl+Alt+ t` and delete any existing _config.json and _settings.json file from `/home/pi/piSignagePro/config` directory

b. Connect Keyboard and press Ctrl-N or F6
* Change config and media server to `http://[your server ip]:port` (ex: 192.168.1.30:3000, 10.50.16.110:3000)
* Open terminal `ctrl+Alt+ t` and delete any existing _config.json and _settings.json file from `/home/pi/piSignagePro/config` directory

c. Connect through ssh
* Edit `/home/pi/piSignagePro/package.json` for admin and media server configuration
* delete any existing _config.json and _settings.json file from `/home/pi/piSignagePro/config` directory

## Features

1. Player management
- Auto discovery of players in a network
- Monitor Players

2. Group management - create groups and assign players to groups
- Display settings - 1080p/720p and landscape or portrait mode
- Deploy default playlist, scheduled playlists and advt playlist
- Assign Players to Groups

3. Assets Management
- Upload assets (video,mp3,html/zip,images, links, google calendar feed)
- Videos are automatically converted to mp4 using ffmpeg
- Thumbnail creation for videos and video metadat extraction to store in data base
- Add labels to manage assets
- View Details of files
- rename or delete files
- view assets locally
- auto label creation for uploaded time (in coming releases)

4. Playlist management
- Create, rename or delete playlists
- Assign assets & drag to change order
- assign duration for non-video assets
- select a layout to show (1,2a,2b,3a,3b,4,4b,2ab)
- Enable ticker & set Ticker text
- Make it ad playlist with configurable interval timer
* Edit `/home/pi/piSignagePro/package.json` for admin and media server configuration
* delete any existing _config.json and _settings.json file from `/home/pi/piSignagePro/config` directory

## Features

1. Player management
- Auto discovery of players in a network
- Monitor Players

2. Group management - create groups and assign players to groups
- Display settings - 1080p/720p and landscape or portrait mode
- Deploy default playlist, scheduled playlists and advt playlist
- Assign Players to Groups

3. Assets Management
- Upload assets (video,mp3,html/zip,images, links, google calendar feed)
- Videos are automatically converted to mp4 using ffmpeg
- Thumbnail creation for videos and video metadat extraction to store in data base
- Add labels to manage assets
- View Details of files
- rename or delete files
- view assets locally
- auto label creation for uploaded time (in coming releases)

4. Playlist management
- Create, rename or delete playlists
- Assign assets & drag to change order
- assign duration for non-video assets
- select a layout to show (1,2a,2b,3a,3b,4,4b,2ab)
- Enable ticker & set Ticker text
- Make it ad playlist with configurable interval timer


### Points to remember

1. angularjs-dropdown-multiselect is taken directly from
https://github.com/dotansimha/angularjs-dropdown-multiselect/pull/23/files instead of bower (for close-on-select to work)
1. angularjs-dropdown-multiselect is taken directly from
https://github.com/dotansimha/angularjs-dropdown-multiselect/pull/23/files instead of bower (for close-on-select to work)

2. Requires following programs to work
- ffmpeg >= 0.9 (in certain OS, these may have to be compiled since the package does not exist,
please see the issue #9)
- ffprobe associated with ffmpeg needed to convert videos
2. Requires following programs to work
- ffmpeg >= 0.9 (in certain OS, these may have to be compiled since the package does not exist,
please see the issue #9)
- ffprobe associated with ffmpeg needed to convert videos
- imagemagick creates thumbnails

3. Two directories are created by the program ../media and ../media/_thumbnails. If these directories are not created server won't work as expected (for e.g. thumbnails won't be created if _thumbnails directory does not exit). In that case create those directories manually.


4. You can also manage players using Browser(http://playerip:8000) or downloading Chrome app

5. Make sure installation under settings page is same as your username (not email) at pisignage.com
5. Make sure installation under settings page is same as your username (not email) at pisignage.com



***Please raise an issue for problems or send us email at support@pisignage.com***
***Please raise an issue for problems or send us email at support@pisignage.com***

0 comments on commit 90a327d

Please sign in to comment.