mirror of
				https://github.com/Frooodle/Stirling-PDF.git
				synced 2025-11-01 01:21:18 +01:00 
			
		
		
		
	# Description of Changes Migrated Stirling PDF to a multi-module structure: * Introduced new `:stirling-pdf` module * Moved all the core logic and features of Stirling PDF into `:stirling-pdf` * Updated paths of jobs and scripts --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
		
			
				
	
	
		
			43 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
			
		
		
	
	
			43 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
services:
 | 
						|
  stirling-pdf:
 | 
						|
    container_name: Stirling-PDF-Security
 | 
						|
    image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest
 | 
						|
    deploy:
 | 
						|
      resources:
 | 
						|
        limits:
 | 
						|
          memory: 4G
 | 
						|
    healthcheck:
 | 
						|
      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
 | 
						|
      interval: 5s
 | 
						|
      timeout: 10s
 | 
						|
      retries: 16
 | 
						|
    ports:
 | 
						|
      - "8080:8080"
 | 
						|
    volumes:
 | 
						|
      - ./stirling/latest/data:/usr/share/tessdata:rw
 | 
						|
      - ./stirling/latest/config:/configs:rw
 | 
						|
      - ./stirling/latest/logs:/logs:rw
 | 
						|
    environment:
 | 
						|
      DISABLE_ADDITIONAL_FEATURES: "false"
 | 
						|
      SECURITY_ENABLELOGIN: "true"
 | 
						|
      SECURITY_OAUTH2_ENABLED: "true"
 | 
						|
      SECURITY_OAUTH2_AUTOCREATEUSER: "true" # This is set to true to allow auto-creation of non-existing users in Stirling-PDF
 | 
						|
      SECURITY_OAUTH2_ISSUER: "https://accounts.google.com"  # Change with any other provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) end-point
 | 
						|
      SECURITY_OAUTH2_CLIENTID: "<YOUR CLIENT ID>.apps.googleusercontent.com" # Client ID from your provider
 | 
						|
      SECURITY_OAUTH2_CLIENTSECRET: "<YOUR CLIENT SECRET>"  # Client Secret from your provider
 | 
						|
      SECURITY_OAUTH2_SCOPES: "openid,profile,email" # Expected OAuth2 Scope
 | 
						|
      SECURITY_OAUTH2_USEASUSERNAME: "email" # Default is 'email'; custom fields can be used as the username
 | 
						|
      SECURITY_OAUTH2_PROVIDER: "google" # Set this to your OAuth provider's name, e.g., 'google' or 'keycloak'
 | 
						|
      PUID: 1002
 | 
						|
      PGID: 1002
 | 
						|
      UMASK: "022"
 | 
						|
      SYSTEM_DEFAULTLOCALE: en-US
 | 
						|
      UI_APPNAME: Stirling-PDF
 | 
						|
      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest with Security
 | 
						|
      UI_APPNAMENAVBAR: Stirling-PDF Latest
 | 
						|
      SYSTEM_MAXFILESIZE: "100"
 | 
						|
      METRICS_ENABLED: "true"
 | 
						|
      SYSTEM_GOOGLEVISIBILITY: "true"
 | 
						|
      SHOW_SURVEY: "true"
 | 
						|
    restart: on-failure:5
 |