onboarding/README.md

72 lines
2.1 KiB
Markdown

# Developer Onboarding
A comprehensive developer environment setup toolkit that automates the installation of essential tools and configures Git and SSH for seamless development workflows.
## Overview
This project provides scripts and documentation to quickly set up a development environment with all the necessary tools, from basic system utilities to modern development tools and containerization platforms.
## Quick Start
### Prerequisites
- Ubuntu/Debian-based Linux system
- `sudo` privileges for package installation
- Internet connection
### Setup Process
1. **Run the onboarding script:**
```bash
chmod +x onboarding.sh
./onboarding.sh
```
2. **Follow the interactive prompts:**
- Configure Git username and email
- Generate SSH keys for secure Git operations
- Test SSH connection to your Git server
## What Gets Configured
### Git Configuration
- Global username and email setup
- Credential caching for convenience
- Color output for better readability
### SSH Key Management
- Ed25519 SSH key generation (modern, secure)
- Automatic key copying to clipboard
- SSH connection testing to Git server
## Files in This Repository
- `onboarding.sh` - Main interactive setup script
- `onboarding.sh.save` - Backup/alternative version
- `applications.md` - Complete list of installed applications
- `README.md` - This file
## Usage Tips
- The script is idempotent - safe to run multiple times
- SSH keys are only generated if they don't already exist
- Git config is only set if not already configured
- All operations are interactive with user confirmation
## Customization
You can modify the `onboarding.sh` script to:
- Change the Git server URL (currently set to `10.0.30.169:3000`)
- Adjust SSH key types or parameters
- Add additional Git configuration options
## Support
If you encounter issues:
1. Ensure you have the required permissions
2. Check network connectivity to the Git server
3. Verify SSH key permissions (`chmod 600 ~/.ssh/id_ed25519`)
## Contributing
Feel free to submit issues or pull requests to improve the onboarding experience.