mlbserver 2022.8.6 → 2022.8.11

package/Dockerfile

@@ -0,0 +1,24 @@
+FROM node:16-alpine
+
+RUN apk update && apk add tzdata
+
+# Create app directory
+WORKDIR /mlbserver
+
+# Add data directory
+VOLUME /mlbserver/data_directory 
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY package*.json ./
+
+RUN npm install
+# If you are building your code for production
+# RUN npm ci --only=production
+
+# Bundle app source
+COPY . .
+
+EXPOSE 9999 10000
+CMD [ "node", "index.js", "--env" ]

package/README.md

@@ -1,24 +1,94 @@
 # mlbserver
 
-Current version 2022.08.06
+Current version 2022.08.11
 
 Credit to https://github.com/tonycpsu/streamglob and https://github.com/mafintosh/hls-decryptor
 
+## Installation
+
+### node-cli
 ```
 npm install -g mlbserver
 ```
 
-## Usage
+### docker
+```
+docker pull tonywagner/mlbserver
+```
+
 
-Launch the server
+## Launch
 
+### node-cli (follow the prompts on first run, or see below for possible command line options)
 ```
 mlbserver
 ```
+or in application directory:
+```
+node index.js
+```
+
+### docker-compose
+Update the environment variables below and save it as docker-compose.yml:
+```
+version: "3"
+services:
+  mlbserver:
+    image: tonywagner/mlbserver:latest
+    container_name: mlbserver
+    environment:
+      - TZ=America/New York
+      - data_directory=/mlbserver/data_directory
+      - account_username=your.account.email@example.com
+      - account_password=youraccountpassword
+      - zip_code=0
+      - fav_teams=0
+      #- zip_code=00000
+      #- fav_teams=ARI,ATL
+      #- debug=false
+      #- port=9999
+      #- multiview_port=10000
+      #- multiview_path=
+      #- ffmpeg_path=
+      #- ffmpeg_encoder=
+      #- page_username=
+      #- page_password=
+      #- content_protect=
+      #- gamechanger_delay=0
+    ports:
+      - 9999:9999
+      - 10000:10000
+    volumes:
+      - /mlbserver/data_directory
+```
+Then launch it with ```docker-compose up --detach```
+
+### docker-cli
+Update the environment variables in the command below and run it:
+```
+docker run -d \
+  --name mlbserver \
+  --env TZ="America/New_York" \
+  --env data_directory=/mlbserver/data_directory \
+  --env account_username=your.account.email@example.com \
+  --env account_password=youraccountpassword \
+  --env zip_code=0 \
+  --env fav_teams=0 \
+  -p 9999:9999 \
+  -p 10000:10000 \
+  --volume /mlbserver/data_directory \
+  tonywagner/mlbserver
+```
+Subsequent runs can be launched with ```docker start mlbserver```
+
+Docker installs may require further configuration to get multiview streaming to work.
+
+
+## Usage
 
-and follow the prompts. Load the resulting web URL in a browser to start using the server and to see more documentation.
+After launching the server or Docker container, you can access it at http://localhost:9999 on the same machine, or substitute your computer's IP address for localhost to access it from a different device. Load that address in a web browser to start using the server and to see more documentation.
 
-Basic command line options:
+Basic command line or Docker environment options:
 
 ```
 --port or -p (primary port to run on; defaults to 9999 if not specified)
@@ -27,9 +97,10 @@ Basic command line options:
 --logout or -l (logs out and clears session)
 --session or -s (clears session)
 --cache or -c (clears cache)
+--env or -e (use environment variables instead of command line arguments; necessary for Docker)
 ```
 
-Advanced command line options:
+Advanced command line or Docker environment options:
 
 ```
 --account_username (email address, default will use stored credentials or prompt user to enter them)

package/docker-compose.yml

@@ -0,0 +1,29 @@
+version: "3"
+services:
+  mlbserver:
+    image: tonywagner/mlbserver:latest
+    container_name: mlbserver
+    environment:
+      - TZ=America/New York
+      - data_directory=/mlbserver/data_directory
+      - account_username=your.account.email@example.com
+      - account_password=youraccountpassword
+      - zip_code=0
+      - fav_teams=0
+      #- zip_code=00000
+      #- fav_teams=ARI,ATL
+      #- debug=false
+      #- port=9999
+      #- multiview_port=10000
+      #- multiview_path=
+      #- ffmpeg_path=
+      #- ffmpeg_encoder=
+      #- page_username=
+      #- page_password=
+      #- content_protect=
+      #- gamechanger_delay=0
+    ports:
+      - 9999:9999
+      - 10000:10000
+    volumes:
+      - /mlbserver/data_directory