From be33164ee6f9b713d6e1952167ebf571650ce5a5 Mon Sep 17 00:00:00 2001 From: Mikael Finstad Date: Sun, 17 Mar 2024 18:16:14 +0800 Subject: [PATCH 1/3] improve companion docs see discussions in https://github.com/transloadit/uppy/issues/4271 --- docs/companion.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/companion.md b/docs/companion.md index 78780a0e9..11a7e060e 100644 --- a/docs/companion.md +++ b/docs/companion.md @@ -126,8 +126,11 @@ const companionOptions = { server: { host: 'localhost:3020', protocol: 'http', - // This MUST match the path you specify in `app.use()` below: - path: '/companion', + // path: '/companion', + // Default installations normally don't need a path. + // However if you specify a `path`, you MUST specify + // the same path in `app.use()` below, + // e.g. app.use('/companion', companionApp) }, filePath: '/path/to/folder/', }; From 336f0aeb9f715afc7a16d1c65bd935149c82db60 Mon Sep 17 00:00:00 2001 From: Mikael Finstad Date: Tue, 19 Mar 2024 14:29:11 +0800 Subject: [PATCH 2/3] Update docs/companion.md Co-authored-by: Antoine du Hamel --- docs/companion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/companion.md b/docs/companion.md index 11a7e060e..ad7c78d1c 100644 --- a/docs/companion.md +++ b/docs/companion.md @@ -126,11 +126,11 @@ const companionOptions = { server: { host: 'localhost:3020', protocol: 'http', - // path: '/companion', // Default installations normally don't need a path. // However if you specify a `path`, you MUST specify // the same path in `app.use()` below, // e.g. app.use('/companion', companionApp) + // path: '/companion', }, filePath: '/path/to/folder/', }; From 7475c8a248e8ba42f1459eb22f3f562317fa511c Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Tue, 16 Apr 2024 14:56:21 +0200 Subject: [PATCH 3/3] prettier --- docs/companion.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/companion.md b/docs/companion.md index a23fa0752..db94bde5e 100644 --- a/docs/companion.md +++ b/docs/companion.md @@ -175,9 +175,9 @@ const companionOptions = { host: 'localhost:3020', protocol: 'http', // Default installations normally don't need a path. - // However if you specify a `path`, you MUST specify - // the same path in `app.use()` below, - // e.g. app.use('/companion', companionApp) + // However if you specify a `path`, you MUST specify + // the same path in `app.use()` below, + // e.g. app.use('/companion', companionApp) // path: '/companion', }, filePath: '/path/to/folder/',