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

FTP POCL references #2085

Merged
merged 2 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docker/env/pocl_job.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,5 @@ SALES_API_TIMEOUT_MS=120000
POCL_FILE_STAGING_TABLE=PoclFileStaging
POCL_RECORD_STAGING_TABLE=PoclRecordStaging

# FTP Settings
POCL_FTP_HOST=host.docker.internal
POCL_FTP_PORT=2222
POCL_FTP_PATH=/share/pocl
POCL_FTP_USERNAME=test_sftp_user
POCL_FTP_KEY_SECRET_ID=/dev/fsh/local/sftp/ssh_ed25519_host_key

# Debug settings
DEBUG=pocl:*,-pocl:ftp
25 changes: 10 additions & 15 deletions packages/pocl-job/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,16 @@ to maintain state during the import process.

# Environment variables

| name | description | required | default | valid | notes |
| ------------------------- | ----------------------------------------------------------------------------------- | :------: | --------- | ----------------------------------------------- | ----- |
| NODE_ENV | Node environment | no | | development, test, production | |
| POCL_FILE_STAGING_TABLE | The DynamoDB table used for staging POCL files | yes | | | |
| POCL_RECORD_STAGING_TABLE | The DynamoDB table used for staging POCL records | yes | | | |
| POCL_STAGING_TTL | The time to live for records in either staging table | no | 168 hours | | |
| POCL_FTP_HOST | The hostname of the target FTP server | yes | | | |
| POCL_FTP_PORT | The port of the FTP service on the target server | yes | | | |
| POCL_FTP_PATH | The base path under which files should be written to the FTP server | yes | | | |
| POCL_FTP_USERNAME | The username used to authenticate with the FTP server | yes | | | |
| POCL_FTP_PRIVATE_KEY_PATH | The path to the folder containing the keys used to authenticate with the FTP server | yes | | | |
| POCL_S3_BUCKET | The name of the AWS S3 bucket in which to stage pocl data | yes | | | |
| DEBUG | Use to enable output of debug information to the console | yes | | pocl:\*, pocl:staging, pocl:transport, pocl:ftp | |
| AIRBRAKE_HOST | URL of airbrake host | no | | | |
| AIRBRAKE_PROJECT_KEY | Project key for airbrake logging | no | | | |
| name | description | required | default | valid | notes |
| ------------------------- | --------------------------------------------------------- | :------: | --------- | ----------------------------------------------- | ----- |
| NODE_ENV | Node environment | no | | development, test, production | |
| POCL_FILE_STAGING_TABLE | The DynamoDB table used for staging POCL files | yes | | | |
| POCL_RECORD_STAGING_TABLE | The DynamoDB table used for staging POCL records | yes | | | |
| POCL_STAGING_TTL | The time to live for records in either staging table | no | 168 hours | | |
| POCL_S3_BUCKET | The name of the AWS S3 bucket in which to stage pocl data | yes | | | |
| DEBUG | Use to enable output of debug information to the console | yes | | pocl:\*, pocl:staging, pocl:transport, pocl:ftp | |
| AIRBRAKE_HOST | URL of airbrake host | no | | | |
| AIRBRAKE_PROJECT_KEY | Project key for airbrake logging | no | | | |

### See also:

Expand Down