colin
/
bootstrap-scripts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
colin 2024-03-20 17:44:41 +00:00
parent c755daddcf
commit c0838e5a23
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,17 +1,34 @@
## Scope
Generic server bootstrap to get some of the most basic utilities installed that would typically be everywhere I deploy these days. This includes ZSH, Sentry, Gluster, Salt, Docker and support tools and various other optimizations.
## Bootstrap Script Documentation
### Scope
This document details the usage of a server bootstrap script aimed at installing essential utilities and configurations for server setups. It supports the installation of ZSH, Docker, along with various optimizations and support tools.
### Usage
To initiate the bootstrap process with the default configuration, embed the following command in your server's post-installation scripts:
## Usage
```bash
#!/usr/bin/env bash
## source <(curl -s https://git.nixc.us/colin/bootstrap-scripts/raw/branch/main/strap.sh) defaults-bootstrap
```
Copy the above into any server post install scripts box and it should get things going pretty quickly.
## Advanced Usage and Provider Specific Deploys
This line fetches and executes the bootstrap script, setting up the server with a standard suite of tools and settings.
### Advanced Usage and Provider Specific Deploys
The bootstrap script accommodates deployments specific to different providers, allowing for the inclusion or exclusion of selected features based on requirements.
#### Example for OVH Deployment:
For deploying on an OVH server with tailored settings, use the example below:
For example if you wanted to deploy to ovh you would use the following example.
```bash
#!/usr/bin/env bash
source <(curl -s https://git.nixc.us/colin/bootstrap-scripts/raw/branch/main/strap.sh) bootstrap ovh gluster nosalt
source <(curl -s https://git.nixc.us/colin/bootstrap-scripts/raw/branch/main/strap.sh) bootstrap ovh nosalt
```
This example demonstrates how to configure a server specifically for OVH, omitting Salt configuration management.
#### Deployment Customization:
- The first argument after `bootstrap` indicates the target cloud provider or environment (e.g., `ovh`, `digitalocean`).
- The second argument allows for specifying configuration preferences, such as excluding Salt stack installation (`nosalt`).
Adjust these parameters to customize the bootstrap process according to your deployment environment and preferences.