Sorty excluded workd in .typo-ci.yaml and add thisismysecret to the list

RasaHQ · Sep 22, 2023 · 1669935 · 1669935
1 parent 1e3d019
commit 1669935
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 75 deletions.
diff --git a/.typo-ci.yml b/.typo-ci.yml
@@ -62,27 +62,43 @@ excluded_files:
 
 # # Any typos we should ignore?
 excluded_words:
+  - CDD
+  - Comerica
+  - ConveRTFeaturizer
+  - ConveRTTokenizer
+  - HookimplMarker
+  - Juste
+  - NLG
+  - README
+  - Tanja
+  - Vova
   - analytics
+  - anonymization
+  - anonymized
   - asyncio
+  - backends
   - bot
   - bot's
   - cdd
-  - CDD
   - cmdline
+  - conftest
   - conveRT
-  - ConveRTFeaturizer
-  - ConveRTTokenizer
+  - crf
+  - crfentityextractor
   - crfsuite
+  - crypto
   - custom-nlg-service
+  - customizable
   - daksh
+  - dataset
   - db's
-  - deque
-  - docusaurus
-  - non-latin
   - deduplicate
   - deduplication
+  - deque
+  - docusaurus
   - donath
-  - matplotlib
+  - dslim
+  - entitysynonymmapper
   - extractor
   - fbmessenger
   - featurization
@@ -95,13 +111,17 @@ excluded_words:
   - forni
   - gzip
   - gzipped
+  - hallo
   - hftransformersnlp
+  - hookimpl
   - initializer
   - instaclient
-  - jwt
-  - jwt's
+  - ish
+  - jieba
   - jupyter
   - jupyterhub
+  - jwt
+  - jwt's
   - karpathy
   - keras
   - knowledgebase
@@ -110,101 +130,82 @@ excluded_words:
   - llm
   - luis
   - matmul
+  - matplotlib
   - mattermost
   - memoization
+  - memoizationpolicy
   - miniconda
   - mitie
-  - mitiefeaturizer
   - mitie's
+  - mitiefeaturizer
   - mitienlp
-  - dataset
   - mongod
   - mrkdown
   - mrkdwn
   - myio
   - mymodelname
   - myuser
-  - numpy
   - networkx
+  - ngram
+  - nlg
   - nlu
   - nlu's
+  - non-latin
+  - numpy
   - perceptron
+  - pii-management
   - pika
   - pika's
-  - jieba
+  - pluggy
+  - pre
   - pretrained
   - prototyper
+  - prototyper
   - pycodestyle
   - pykwalify
   - pymessenger
   - pyobject
   - python-engineio
-  - pre
-  - customizable
   - quickstart
   - rasa
   - rasa's
   - readthedocs
+  - regexes
+  - regexfeaturizer
   - regularizer
   - repo
   - rst
+  - ruamel
+  - rustc
+  - rustup
+  - rustup-init
   - sanic
   - sanitization
   - scipy
   - sklearn
   - socketio
+  - spaCy
+  - spaCy's
   - spacy
   - spacyfeaturizer
   - spacynlp
-  - ish
-  - spaCy
-  - spaCy's
-  - README
-  - crf
-  - backends
-  - whitespaced
-  - ngram
   - subsampled
   - testagent
+  - thisismysecret
+  - tokenization
   - tokenize
   - tokenized
-  - tokenization
   - tokenizer
   - tokenizers
   - tokenizing
   - typoci
   - unfeaturized
   - unschedule
-  - wsgi
-  - ruamel
-  - prototyper
-  - hallo
-  - crypto
-  - regexes
+  - venv
   - walkthroughs
   - webexteams
-  - venv
-  - regexfeaturizer
-  - crfentityextractor
-  - Comerica
-  - entitysynonymmapper
-  - memoizationpolicy
-  - NLG
-  - nlg
-  - Juste
-  - Tanja
-  - Vova
-  - rustup
-  - rustup-init
-  - rustc
-  - conftest
+  - whitespaced
   - winpty
-  - pii-management
-  - anonymization
-  - anonymized
-  - dslim
-  - pluggy
-  - HookimplMarker
-  - hookimpl
+  - wsgi
 
 spellcheck_filenames: false
diff --git a/docs/docs/http-api.mdx b/docs/docs/http-api.mdx
@@ -100,22 +100,18 @@ rasa run \
     --jwt-secret thisismysecret
 ```
 
-or via environment variable:
+You can also use environment variable `JWT_SECRET` to set the JWT secret:
+```
+JWT_SECRET=thisismysecret
+```
+
 :::tip Security best practice
 
 We recommend that you use environment variables to store
-sensitive information such as tokens and secrets
-as they will not be stored in your shell history.
-
+and share sensitive information such as tokens and secrets
+when deploying Rasa as Docker container as they will not be stored in your shell history.
 :::
 
-
-```bash
-export JWT_SECRET=thisismysecret
-rasa run \
-    --enable-api
-```
-
 If you want to sign a JWT token with asymmetric algorithms, you can specify the JWT private key to the `--jwt-private-key`
 CLI argument. You must pass the public key to the `--jwt-secret` argument, and also specify the algorithm to the
 `--jwt-method` argument:
@@ -128,23 +124,20 @@ rasa run \
     --jwt-method RS512
 ```
 
-or via environment variables:
+You can also use environment variables to configure JWT:
+```
+JWT_SECRET=<public_key>
+JWT_PRIVATE_KEY=<private_key>
+JWT_METHOD=RS512
+```
+
 :::tip Security best practice
 
 We recommend that you use environment variables to store
-sensitive information such as tokens and secrets
-as they will not be stored in your shell history.
-
+and share sensitive information such as tokens and secrets
+when deploying Rasa as Docker container as they will not be stored in your shell history.
 :::
 
-```bash
-export JWT_SECRET=<public_key>
-export JWT_PRIVATE_KEY=<private_key>
-export JWT_METHOD=RS512
-rasa run \
-    --enable-api
-```
-
 Client requests to the server will need to contain a valid JWT token in
 the `Authorization` header that is signed using this secret
 and the `HS256` algorithm e.g.