{"id":23060835,"url":"https://github.com/syncfusionexamples/pdfviewer-server","last_synced_at":"2025-08-15T08:32:07.692Z","repository":{"id":37160744,"uuid":"343422451","full_name":"SyncfusionExamples/PdfViewer-Server","owner":"SyncfusionExamples","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-03T05:10:01.000Z","size":2995,"stargazers_count":6,"open_issues_count":3,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-03T06:19:26.010Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SyncfusionExamples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-01T13:16:15.000Z","updated_at":"2024-05-24T09:43:13.000Z","dependencies_parsed_at":"2024-12-03T06:19:04.585Z","dependency_job_id":"7231e94e-994f-4eed-b1b0-f8e22ff28b30","html_url":"https://github.com/SyncfusionExamples/PdfViewer-Server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyncfusionExamples%2FPdfViewer-Server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyncfusionExamples%2FPdfViewer-Server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyncfusionExamples%2FPdfViewer-Server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyncfusionExamples%2FPdfViewer-Server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SyncfusionExamples","download_url":"https://codeload.github.com/SyncfusionExamples/PdfViewer-Server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229901551,"owners_count":18141741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T03:15:27.823Z","updated_at":"2024-12-16T03:15:28.329Z","avatar_url":"https://github.com/SyncfusionExamples.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview:\n\nThe Syncfusion\u0026reg; PDF Viewer control allows you to view, print, form-fill, and annotate PDF files in your web applications. This PDF Viewer control requires a server-side backend Web API service to render PDF contents.\n\nThis Docker image is the predefined Docker container of Syncfusion’s PDF Viewer backend. You can deploy it quickly to your infrastructure.\n\n# Prerequisites \n\nHave [Docker](https://www.docker.com/products/container-runtime#/download) installed in your environment: \n\n•\tOn Windows, install [Docker for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows). \n\n•\tOn macOS, install [Docker for Mac](https://hub.docker.com/editions/community/docker-ce-desktop-windows).\n\n\n# Configure the PDF Viewer server-side service \n \nThis PDF Viewer component uses a server-side backend (web service) to render the pages and extract the PDF contents. We have provided the server-side backend (web service) as a docker image to quickly get started with our PDF Viewer component. \n \nStep 1: Pull the pdfviewer-server image from Docker Hub. \n\n```sh\ndocker pull syncfusion/pdfviewer-server \n```\n\n**NOTE:** PDF Viewer is a commercial product, and it requires a valid license to use it in a production environment [request license or trial key](https://help.syncfusion.com/common/essential-studio/licensing/licensing-faq/where-can-i-get-a-license-key). \n \nStep 2: Create the docker-compose.yml file with the following code in your file system. \n  \n```sh\nversion: '3.4'  \n \nservices:  \n pdfviewer-server: \n    image: syncfusion/pdfviewer-server:latest \n    environment:  \n      #Provide your license key for activation \n       SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY \n    volumes:  \n      -  C:\\Docker\\Data:/app/Data \n    ports: \n    - \"6001:80\" \n```\n\n**NOTE:** You should mention the folder path which contains pdf files in the volumes section of compose file. \n \nStep 3: In a terminal tab, navigate to the directory where you’ve placed the docker-compose.yml file and execute the following. \n\n```sh\ndocker-compose up \n```\n\nAlso, you can run the Docker container along with the license key using this docker run command. \n\n```sh\ndocker run -d -p 6001:80 –e SYNCFUSION_LICENSE_KEY=YOUR_LICENSE_KEY syncfusion/pdfviewer-server:latest \n```\n\nFor Ex: docker run -d -p 6001:80 –e SYNCFUSION_LICENSE_KEY=Mzg1ODMzQDMxMzgyZTM0MmUzMGdFRGJvUno1MUx4Tit4S09CeS9xRHZzZU4ySVBjQVFuT0VpdWpHUWJ6aXM9 syncfusion/pdfviewer-server:latest \nNow the PDF Viewer server Docker instance runs in the localhost with the provided port number http://localhost:6001. Open this link in the browser and navigate to the PDF Viewer Web API control http://localhost:6001/api/pdfviewer. It returns the default get method response. \n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncfusionexamples%2Fpdfviewer-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyncfusionexamples%2Fpdfviewer-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncfusionexamples%2Fpdfviewer-server/lists"}