Skip to content

A self-hosting version of Kibana customized for a homelab.

License

Notifications You must be signed in to change notification settings

clonne101/kibana

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kibana on Alpine Linux Container

Description

A docker-compose setup for running and managing Kibana (check Installation)

Table of Contents

Installation

Detailed steps to set up the project on your Alpine LXC Container.

  • Create .ashrc under /root with the following content
# Set PATH
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

# Aliases
alias ll='ls -alF'
alias la='ls -A'
alias grep='grep --color=auto'

# Cargo
. "$HOME/.cargo/env"
  • Create .profile under /root with the following content
export ENV=$HOME/.ashrc

  • Clone the repository
# Clone the repository
git clone https://github.com/clonne101/kibana.git kibana-docker

# Navigate to the project directory
cd kibana-docker

# Copy `.env.example` to `.env` under `/root/kibana-docker/docker` by running the
# command below and update the `variables`
cp /root/kibana-docker/docker/.env.example /root/kibana-docker/docker/.env

Usage

Before running any of the commands below, kindly make sure you have completed the above installations for you Alpine Box.

#### Create required data directories - REQUIRED on FIRST-RUN
make create-dirs

#### Start kibana container
make start

#### Stop kibana container
make stop

#### Tail kibana container logs
make logs

#### Show kibana containers
make show

#### Clean kibana  containers and volumes
make clean

#### Prints out command list when in doubt
make help

Contributing

Guidelines for contributing to the project.

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request.

Submitting Issues

If you encounter any issues, have questions, or would like to suggest an enhancement, please submit an issue through the GitHub repository.

Steps to Submit an Issue

  1. Search for existing issues: Before creating a new issue, please check if the issue has already been reported.
  2. Open a new issue: If no existing issue matches your problem, open a new issue by clicking on the "New Issue" button in the Issues tab.
  3. Describe the issue: Provide a clear and concise description of the issue. Include steps to reproduce the problem, expected behavior, and actual behavior. If applicable, add screenshots or code snippets to illustrate the issue.
  4. Label the issue: Add relevant labels (e.g., bug, enhancement, question) to help categorize the issue.

License

This project is licensed under the GPLv3 License.

Code of Conduct

Please read the Code of Conduct for details.

Contact

Acknowledgments