Renamed project

Author: Zozman

.env.example

@@ -1,7 +1,7 @@
 # To use this file, copy it to `.env` and update and/or add your own values.
 # Be sure to read the `Environment Variables` section in the README.
-# Website to capture and stream
-WEBSITE_URL=https://example.com
+# Webpage to capture and stream
+WEBPAGE_URL=https://example.com
 # RTMP endpoint to stream to
 RTMP_URL=rtmp://localhost:1935/live/stream
 # Output resolution (720p, 1080p, or 2k)

README.md

@@ -1,6 +1,6 @@
-# Stream Website Container
+# Stream Webpage Container
 
-A containerized application to stream a webpage live over RTMP.  Just pass a `WEBSITE_URL` and a `RTMP_URL` and the container will open a browser, capture the video and audio, and send it to the specified location.  It can even be configured to automatically restart the stream for supported services.
+A containerized application to stream a webpage live over RTMP.  Just pass a `WEBPAGE_URL` and a `RTMP_URL` and the container will open a browser, capture the video and audio, and send it to the specified location.  It can even be configured to automatically restart the stream for supported services.
 
 ## Uses
 
@@ -40,13 +40,13 @@ You can then use a program like VLC to view the stream to ensure it works (use `
 
 ```bash
 # Build the image
-docker build -t stream-website .
+docker build -t stream-webpage .
 
 # Run the container
-docker run -e WEBSITE_URL="https://example.com" \
+docker run -e WEBPAGE_URL="https://example.com" \
            -e RTMP_URL="rtmp://your-server/live/stream" \
            -e RESOLUTION="1080p" \
-           stream-website
+           stream-webpage
 ```
 
 > [!WARNING]
@@ -122,10 +122,10 @@ To enable status checking for Twitch, provide a `TWITCH_CHANNEL`, `TWITCH_CLIENT
    - Twitch Client ID obtained from the [Twitch Developer Console](https://dev.twitch.tv/console) for checking stream status if the `TWITCH_CHANNEL` environmental variable is set.
    - Checking for the stream status on Twitch will not work without this and `TWITCH_CLIENT_ID` being set.
    - For more information about registering an app on Twitch, see [the developer documentation](https://dev.twitch.tv/docs/authentication/register-app/).
-- `WEBSITE_URL`
+- `WEBPAGE_URL`
    - String
    - Default: `https://google.com`
-   - The website to stream.
+   - The webpage to stream.
 
 ## About
 

cmd/main.go

@@ -21,17 +21,17 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapio"
 
-	"github.com/Zozman/stream-website/twitch"
-	"github.com/Zozman/stream-website/utils"
+	"github.com/Zozman/stream-webpage-container/twitch"
+	"github.com/Zozman/stream-webpage-container/utils"
 )
 
 const (
 	// Default resoltion for streams sent by the application
 	DefaultResolution = "720p"
 	// Default RTMP URL to stream to
 	DefaultRTMPURL = "rtmp://localhost:1935/live/stream"
-	// Default website to capture
-	DefaultWebsiteURL = "https://google.com"
+	// Default webpage to capture
+	DefaultWebpageURL = "https://google.com"
 	// Default framerate for the stream
 	DefaultFramerate = "30"
 	// Default cron string for checking stream status
@@ -142,7 +142,7 @@ func StopCurrentStream(ctx context.Context) {
 // Struct representing the configuration for the stream
 type Config struct {
 	// The URL of the webstie to stream
-	WebsiteURL string
+	WebpageURL string
 	// The RTMP URL to stream to
 	RTMPURL string
 	// The resolution of the stream
@@ -171,8 +171,8 @@ func main() {
 		logger.Fatal("Failed to load configuration", zap.Error(err))
 	}
 
-	logger.Debug("Starting website stream capture",
-		zap.String("website", config.WebsiteURL),
+	logger.Debug("Starting webpage stream capture",
+		zap.String("webpage", config.WebpageURL),
 		zap.String("rtmp", config.RTMPURL),
 		zap.String("resolution", config.Resolution),
 		zap.String("framerate", config.Framerate),
@@ -235,7 +235,7 @@ func main() {
 		// This will be triggered by the cron job or manual restarts
 		default:
 			logger.Info("Starting/restarting stream...")
-			if err := streamWebsite(ctx, config); err != nil {
+			if err := streamWebpage(ctx, config); err != nil {
 				if ctx.Err() != nil {
 					logger.Info("Stream stopped due to context cancellation")
 					return
@@ -271,7 +271,7 @@ func loadConfig(ctx context.Context) (*Config, error) {
 	logger := utils.GetLoggerFromContext(ctx)
 
 	config := &Config{
-		WebsiteURL: utils.GetEnvOrDefault("WEBSITE_URL", DefaultWebsiteURL),
+		WebpageURL: utils.GetEnvOrDefault("WEBPAGE_URL", DefaultWebpageURL),
 		RTMPURL:    utils.GetEnvOrDefault("RTMP_URL", DefaultRTMPURL),
 		Resolution: utils.GetEnvOrDefault("RESOLUTION", DefaultResolution),
 		Framerate:  utils.GetEnvOrDefault("FRAMERATE", DefaultFramerate),
@@ -312,8 +312,8 @@ func loadConfig(ctx context.Context) (*Config, error) {
 	return config, nil
 }
 
-// Function to stream the specified website using Chrome and FFmpeg
-func streamWebsite(ctx context.Context, config *Config) error {
+// Function to stream the specified webpage using Chrome and FFmpeg
+func streamWebpage(ctx context.Context, config *Config) error {
 	logger := utils.GetLoggerFromContext(ctx)
 
 	// Check if a stream is already running and stop it
@@ -356,14 +356,14 @@ func streamWebsite(ctx context.Context, config *Config) error {
 	chromeCtx, chromeCancel := chromedp.NewContext(allocCtx)
 	defer chromeCancel()
 
-	// Start Chrome and navigate to website
-	logger.Info("Starting Chrome browser", zap.String("url", config.WebsiteURL))
+	// Start Chrome and navigate to webpage
+	logger.Info("Starting Chrome browser", zap.String("url", config.WebpageURL))
 
 	if err := chromedp.Run(chromeCtx,
-		chromedp.Navigate(config.WebsiteURL),
+		chromedp.Navigate(config.WebpageURL),
 		chromedp.WaitVisible("body", chromedp.ByQuery),
 	); err != nil {
-		return fmt.Errorf("failed to navigate to website: %v", err)
+		return fmt.Errorf("failed to navigate to webpage: %v", err)
 	}
 
 	// Wait a moment for the page to fully load

docker-compose.yml

@@ -1,5 +1,5 @@
 services:
-  stream-website:
+  stream-webpage:
     build: .
     environment:
       - FRAMERATE=${FRAMERATE:-60}
@@ -12,7 +12,7 @@ services:
       - TWITCH_CHANNEL=${TWITCH_CHANNEL}
       - TWITCH_CLIENT_ID=${TWITCH_CLIENT_ID}
       - TWITCH_CLIENT_SECRET=${TWITCH_CLIENT_SECRET}
-      - WEBSITE_URL=${WEBSITE_URL:-https://google.com}
+      - WEBPAGE_URL=${WEBPAGE_URL:-https://google.com}
     ports:
       - "${PORT:-8080}:${PORT:-8080}"
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/Zozman/stream-website
+module github.com/Zozman/stream-webpage-container
 
 go 1.24
 

twitch/client.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/nicklaw5/helix/v2"
 
-	"github.com/Zozman/stream-website/utils"
+	"github.com/Zozman/stream-webpage-container/utils"
 )
 
 var (