mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2024-11-10 18:00:11 +01:00
2.0 KiB
2.0 KiB
Pipeline Configuration and Usage Tutorial
- Configure the pipeline config file and input files to run files against it
- For reuse, download the config file and re-upload it when needed, or place it in /pipeline/defaultWebUIConfigs/ to auto-load in the web UI for all users
Steps to Configure and Use Your Pipeline
-
Access Configuration
- Upon entering the screen, click on the Configure button.
-
Enter Pipeline Name
- Provide a name for your pipeline in the designated field.
-
Select Operations
- Choose the operations for your pipeline (e.g., Split Pages), then click Add Operation.
-
Configure Operation Settings
- Input the necessary settings for each added operation. Settings are highlighted in yellow if customization is needed.
-
Add More Operations
- You can add and adjust the order of multiple operations. Ensure each operation's settings are customized.
-
Save Settings
- Click Save Operation Settings after customizing settings for each operation.
-
Validate Pipeline
- Use the Validation button to check your pipeline. A green indicator signifies correct setup; a pop-out error indicates issues.
-
Download Pipeline Configuration
- To use the configuration for folder scanning (or save it for future use and reupload it), you can also download a JSON file in this menu. You can also pre-load this for future use by placing it in
/pipeline/defaultWebUIConfigs/
. It will then appear in the dropdown menu for all users to use.
- To use the configuration for folder scanning (or save it for future use and reupload it), you can also download a JSON file in this menu. You can also pre-load this for future use by placing it in
-
Submit Files for Processing
- If your pipeline is correctly set up close the configure menu, input the files and hit Submit.
-
Note on Web UI Limitations
- The current web UI version does not support operations that require multiple different types of inputs, such as adding a separate image to a PDF.
Current Limitations
- Cannot have more than one of the same operation
- Cannot input additional files via UI
- All files and operations run in serial mode