Skip to content

Commit aa9288e

Browse files
committed
docs: adds FAQ
1 parent c813d5f commit aa9288e

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/.vuepress/config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ module.exports = {
6262
path: '/release-notes',
6363
children: [['/release-notes', 'Release Notes'], '/v2-announcement', '/v2-migration'],
6464
},
65+
{
66+
title: 'FAQ',
67+
path: '/faq',
68+
},
6569
],
6670

6771
docsRepo: 'launchcodedev/app-config',

docs/faq.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Frequently Asked Questions
3+
---
4+
5+
## Frequently Asked Questions
6+
7+
**I'm getting "SecretsRequireTTY" errors in CI.**
8+
9+
::: details Answer
10+
This error occurs when App Config is trying to decrypt secrets. To do so,
11+
it needs to unlock the repository's private keys. If the global keychain
12+
has a passphrase, this cannot be done without prompting the user for a
13+
passphrase on stdin.
14+
15+
In environments in CI, there's no TTY, and therefore, we can't prompt the user!
16+
17+
You likely want to create a passphrase-less team member, using `app-config secrets ci` subcommand.
18+
Or, for local development, run the `app-config secret agent`!
19+
:::
20+
21+
---
22+
23+
**I'm getting "module not found" or something similar (like "fs" problems), in a web app.**
24+
25+
::: details Answer
26+
Usually, this means you haven't set up our webpack plugin correctly.
27+
28+
Our plugin internally "rewrites" the app-config NPM module, only exposing a very minimal surface.
29+
So it's likely that Webpack is trying to load the Node.js module, but failing because we use
30+
Node.js APIs internally.
31+
:::
32+
33+
---
34+
35+
**How I use App Config with Create React App?**
36+
37+
::: details Answer
38+
Find a way to add Webpack configuration (there's plenty out there), and follow our instructions for that.
39+
:::
40+
41+
---
42+
43+
**How I use App Config with XYZ?**
44+
45+
::: details Answer
46+
File a GitHub issue on our repository, and we'll see if we can officially support it.
47+
:::

0 commit comments

Comments
 (0)