Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration options #1449

Merged
merged 3 commits into from
Nov 5, 2023
Merged

Configuration options #1449

merged 3 commits into from
Nov 5, 2023

Conversation

toshski
Copy link
Contributor

@toshski toshski commented Oct 25, 2023

The following items and now configurable at runtime.

Command Switch/Environment variable - Description

  • app_dir/XBVR_APPDIR - base XBVR directory
  • cache_dir/XBVR_CACHEDIR - tempoary cache for scrapers
  • imgproxy_dir/XBVR_IMAGEPROXYDIR - internal image proxy location
  • search_dir/XBVR_SEARCHDIR - Search Index location
  • preview_dir/XBVR_VIDEOPREVIEWDIR - Video preview files
  • scripts_heatmap_dir/XBVR_SCRIPTHEATMAPDIR - Heatmap images
  • database_url/DATABASE_URL (existing) - database connection string
  • web_port/XBVR_WS_ADDR - Web Page port, note using this will update the setting in the db
  • ws_addr/XBVR_WEB_PORT - Web Service port 9998

These changes are primarily of use to help with Development environments. However, they may be useful to other users e.g. overriding the default directory location, can help manage space, e.g., on Windows the default location is the system drive. Overriding individual directories can also allow sharing directories between multiple instances, eg developers could override the Video Preview directory to share a single preview directory between multiple development instances.

The Web Service port is now configurable to allow multiple instances of XBVR on a platform, eg Windows, not really required if using Dockers. Overriding the default APPDIR also helps run multiple instances.

All switches are Optional. Run Command take priority over Environment variables, which take priority over database settings (where applicable)
Example run command: c:\xbvr\xbvr.exe -app_dir "D:\xbvr_dev1" -web_port 9980 -ws_addr 0.0.0.0:9981 -database_url "mysql://root:password@192.168.1.1:3306/xbvr_dev1?charset=utf8mb4&parseTime=True&loc=Local"

@crwxaj crwxaj merged commit 6f26070 into xbapps:master Nov 5, 2023
1 check passed
@toshski toshski deleted the Configuration_Options branch November 16, 2023 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants