From 01ec68d80a2186c1e23b82114f5e2fe3dcd50bed Mon Sep 17 00:00:00 2001 From: Arthur Hanson Date: Fri, 27 Sep 2024 17:05:39 -0700 Subject: [PATCH] add documentation for installing python_socks --- docs/features/synchronized-data.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/features/synchronized-data.md b/docs/features/synchronized-data.md index 8c95c8779..95656f6d1 100644 --- a/docs/features/synchronized-data.md +++ b/docs/features/synchronized-data.md @@ -13,6 +13,9 @@ To enable remote data synchronization, the NetBox administrator first designates !!! info Data backends which connect to external sources typically require the installation of one or more supporting Python libraries. The Git backend requires the [`dulwich`](https://www.dulwich.io/) package, and the S3 backend requires the [`boto3`](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) package. These must be installed within NetBox's environment to enable these backends. +!!! info + If you are configuring Git and have HTTP_PROXIES set to use the SOCKS protocol, you will also need to install the [`python_socks`](https://pypi.org/project/python-socks/) package. + Each type of remote source has its own configuration parameters. For instance, a git source will ask the user to specify a branch and authentication credentials. Once the source has been created, a synchronization job is run to automatically replicate remote files in the local database. The following NetBox models can be associated with replicated data files: