update description
This commit is contained in:
parent
2e79bebcc4
commit
c8723c981e
@ -1,12 +1,23 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "hosttoday",
|
||||
"gitrepo": "ht-docker-elk",
|
||||
"shortDescription": "elastic stack with full basic authentication",
|
||||
"npmPackagename": "@hosttoday/ht-docker-node",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"description": "A Docker image for running the Elastic Stack with added support for full basic authentication.",
|
||||
"keywords": [
|
||||
"Elastic Stack",
|
||||
"Docker",
|
||||
"Basic Authentication",
|
||||
"Security",
|
||||
"Elasticsearch",
|
||||
"Logstash",
|
||||
"Kibana",
|
||||
"Containerization"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
@ -14,5 +25,8 @@
|
||||
"docker.io",
|
||||
"registry.gitlab.com"
|
||||
]
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
14
package.json
14
package.json
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "ht-docker-elk",
|
||||
"version": "1.0.16",
|
||||
"description": "elastic stack with full basic authentication",
|
||||
"description": "A Docker image for running the Elastic Stack with added support for full basic authentication.",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\"",
|
||||
@ -28,5 +28,15 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"Elastic Stack",
|
||||
"Docker",
|
||||
"Basic Authentication",
|
||||
"Security",
|
||||
"Elasticsearch",
|
||||
"Logstash",
|
||||
"Kibana",
|
||||
"Containerization"
|
||||
]
|
||||
}
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
103
readme.md
103
readme.md
@ -1,35 +1,92 @@
|
||||
# @hosttoday/ht-docker-elk
|
||||
# ht-docker-elk
|
||||
elastic stack with full basic authentication
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@hosttoday/ht-docker-node)
|
||||
* [gitlab.com (source)](https://gitlab.com/hosttoday/ht-docker-elk)
|
||||
* [github.com (source mirror)](https://github.com/hosttoday/ht-docker-elk)
|
||||
* [docs (typedoc)](https://hosttoday.gitlab.io/ht-docker-elk/)
|
||||
## Install
|
||||
To use the `ht-docker-elk` in your project, you need Docker installed on your machine. If Docker is not yet installed, follow the installation instructions for your specific operating system on the [official Docker website](https://docs.docker.com/get-docker/).
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/hosttoday/ht-docker-elk/commits/master)
|
||||
[](https://gitlab.com/hosttoday/ht-docker-elk/commits/master)
|
||||
[](https://www.npmjs.com/package/@hosttoday/ht-docker-node)
|
||||
[](https://snyk.io/test/npm/@hosttoday/ht-docker-node)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
Once Docker is up and running, you can proceed with the setup of `ht-docker-elk`. Since this project is set to private, and the setup may require access to a proprietary or internal registry, ensure you have the necessary permissions or access tokens to pull the Docker image.
|
||||
|
||||
## Usage
|
||||
|
||||
This image runs the elastic stack and supports full basic authentication
|
||||
The `ht-docker-elk` project provides an easy and secure way to deploy the Elastic Stack with full basic authentication. This section will cover several use cases and show how to utilize the project effectively in different scenarios, ensuring you can leverage the full suite of features offered by the Elastic Stack, securely and efficiently.
|
||||
|
||||
```
|
||||
docker run --rm -d --name elstack -p 3000:3000 -p 9200:9201 -e SSL=true -e ELSK_USER="anyuser" -e ELSK_PASS="anypass" registry.gitlab.com/hosttoday/ht-docker-elk
|
||||
### Basic Setup
|
||||
|
||||
To get started, you'll need to run the Docker container provided by `ht-docker-elk`. This can be achieved by executing the following command in your terminal:
|
||||
|
||||
```typescript
|
||||
docker run --rm -d --name elstack \
|
||||
-p 3000:3000 -p 9200:9201 \
|
||||
-e SSL=true \
|
||||
-e ELSK_USER="anyuser" \
|
||||
-e ELSK_PASS="anypass" \
|
||||
registry.gitlab.com/hosttoday/ht-docker-elk
|
||||
```
|
||||
|
||||
## Contribute
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. + Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: [Contribute monthly :)](https://lossless.link/contribute)
|
||||
This command accomplishes the following:
|
||||
- Starts a Docker container in detached mode (`-d`) and names it `elstack`.
|
||||
- Maps port `3000` on the host to port `3000` on the container, and port `9200` on the host to port `9201` on the container. These ports are essential for accessing Kibana and Elasticsearch, respectively.
|
||||
- Enables SSL encryption (`SSL=true`) for secure communication.
|
||||
- Sets up basic authentication with the given username (`ELSK_USER`) and password (`ELSK_PASS`).
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
### Advanced Configuration
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
Assuming more advanced configurations are not omitted from this template due to its conciseness, an advanced use case might involve setting up persistent storage for Elasticsearch or configuring custom Kibana plugins. For persistent storage, you would typically use Docker volumes:
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
```typescript
|
||||
docker run --rm -d --name elstack \
|
||||
-p 3000:3000 -p 9200:9201 \
|
||||
-e SSL=true \
|
||||
-e ELSK_USER="anyuser" \
|
||||
-e ELSK_PASS="anypass" \
|
||||
-v my-elasticsearch-data:/usr/share/elasticsearch/data \
|
||||
registry.gitlab.com/hosttoday/ht-docker-elk
|
||||
```
|
||||
|
||||
This example attaches a volume named `my-elasticsearch-data` to the Elasticsearch data directory inside the container, ensuring that your data persists across container restarts.
|
||||
|
||||
For configuring custom Kibana plugins, one might need to build a custom Docker image based on `ht-docker-elk`, where the Dockerfile includes steps to install additional plugins. This could look something like this:
|
||||
|
||||
```Dockerfile
|
||||
FROM registry.gitlab.com/hosttoday/ht-docker-elk
|
||||
|
||||
# Example: Installing a custom Kibana plugin
|
||||
RUN kibana-plugin install <plugin-url>
|
||||
```
|
||||
|
||||
### Monitoring & Management
|
||||
|
||||
Utilizing the capabilities of the Elastic Stack, you may want to enable features like monitoring or alerting to keep an eye on the health and performance of your deployment. Enabling X-Pack monitoring within the Elasticsearch and Kibana can provide deep insights into your stack's operation.
|
||||
|
||||
Given the project's setup, specific configuration files would need to be adjusted to enable and configure these features, typically by mounting a custom configuration file into the Docker container.
|
||||
|
||||
This could be achieved with an additional volume mount in your `docker run` command:
|
||||
|
||||
```typescript
|
||||
-v ./my_custom_kibana.yml:/usr/share/kibana/config/kibana.yml
|
||||
```
|
||||
|
||||
Here, `my_custom_kibana.yml` contains your specific configurations for Kibana, including the setup for monitoring, alerting, and any other X-Pack features you wish to enable.
|
||||
|
||||
## Conclusion
|
||||
|
||||
`ht-docker-elk` provides a robust and secure way to deploy the Elastic Stack, catering to both simple and complex use cases with ease. By ensuring secure access through basic authentication and the possibility for SSL encryption, it stands as a solid choice for anyone looking to deploy Elasticsearch, Logstash, and Kibana in a Dockerized environment.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user