https://github.com/dploeger/tflookup
Terraform documentation lookup
https://github.com/dploeger/tflookup
documentation terraform tool
Last synced: 8 months ago
JSON representation
Terraform documentation lookup
- Host: GitHub
- URL: https://github.com/dploeger/tflookup
- Owner: dploeger
- Archived: true
- Created: 2019-05-22T10:30:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T08:28:04.000Z (almost 2 years ago)
- Last Synced: 2024-12-20T00:48:40.767Z (over 1 year ago)
- Topics: documentation, terraform, tool
- Language: TypeScript
- Homepage: https://tflookup.herokuapp.com/
- Size: 2.69 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**This repository is archived as the current Terraform registry is better than it was before**
# tflookup - Terraform Documentation Lookup
## Introduction
This web app is a searchable index of the Terraform provider documentation and lets you quickly jump to the relevant page you're looking for.
## Missing documentation
Currently, some documentations have bugs and can not be indexed by the process. Check out the indexErrors.txt for a current list of invalid files.
## Building
To build this app, you'll have to build the static app and the server:
cd static
npm install
npm run-script build
cd ..
grunt build
## Running
To run the server, that delivers the API and web app, run
node index.js
## Providing an index
By default, the server will build up an index by indexing the terraform-website submodule. Cloning the submodules takes a **long** time, so there's a secondary option.
There's a pre-built index called documentationIndex.json which can be used by setting the environment variable TFLOOKUP_INDEXFILE:
TFLOOKUP_INDEXFILE=documentationIndex.json node index.js
## Building the index file
The index file is built and commited periodically built by an external cronjob, that uses the "updateIndex.sh" script.
## Docker
You can also use a docker image to run the server by running
docker build -t tflookup:latest .
docker run --name tflookup --rm -d -P tflookup:latest
docker port tflookup
This will start the server and show you the mapped port where you can access it locally.