https://github.com/gableroux/debian-service-generator
Generate debian services based on Sample /etc/init.d naholyr's gist
https://github.com/gableroux/debian-service-generator
automation debian script service shell
Last synced: about 2 months ago
JSON representation
Generate debian services based on Sample /etc/init.d naholyr's gist
- Host: GitHub
- URL: https://github.com/gableroux/debian-service-generator
- Owner: GabLeRoux
- License: mit
- Created: 2018-05-30T20:17:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T03:31:17.000Z (about 8 years ago)
- Last Synced: 2025-03-30T20:50:02.870Z (about 1 year ago)
- Topics: automation, debian, script, service, shell
- Language: Shell
- Homepage:
- Size: 281 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sample service script for debianoids
Generate debian services based on [Sample /etc/init.d naholyr's gist](https://gist.github.com/naholyr/4275302) and [wyhasany/sample-service-script repository](https://github.com/wyhasany/sample-service-script)
## Resources
* [LSB init scripts](http://wiki.debian.org/LSBInitScripts) for more information.
* [MetaInit debian package](https://wiki.debian.org/MetaInit) to do something similar as this repository
## Usage
Copy to `/etc/init.d`:
```sh
# replace "$YOUR_SERVICE_NAME" with your service's name (whenever it's not enough obvious)
cp "service.sh" "/etc/init.d/$YOUR_SERVICE_NAME"
chmod +x /etc/init.d/$YOUR_SERVICE_NAME
```
Edit the script and replace following tokens:
* `` = `$YOUR_SERVICE_NAME`
* `` = Describe your service here (be concise)
* Feel free to modify the LSB header, I've made default choices you may not agree with
* `` = Command to start your server (for example `/home/myuser/.dropbox-dist/dropboxd`)
* `` = Login of the system user the script should be run as (for example `myuser`)
Start and test your service:
```sh
service $YOUR_SERVICE_NAME start
service $YOUR_SERVICE_NAME stop
```
Install service to be run at boot-time:
```sh
update-rc.d $YOUR_SERVICE_NAME defaults
```
For rpm based distributions such as CentOS or Red Hat, you can use
```sh
chkconfig $YOUR_SERVICE_NAME --add
```
If you want to see which runlevel your script will run in
```sh
chkconfig $YOUR_SERVICE_NAME --list
```
Enjoy
## Uninstall
The service can uninstall itself with `service $NAME uninstall`. Yes, that's very easy, therefore a bit dangerous. But as it's an auto-generated script, you can bring it back very easily. I use it for tests and often install/uninstall, that's why I've put that here.
Don't want it? Remove lines 56-58 of the service's script.
## Logs?
Your service will log its output to `/var/log/$NAME.log`. Don't forget to setup a *logrotate*.
### logrotate example
Using heredocs to create `/etc/logrotate.d/$NAME.conf` :tada:
```sh
cat << EOF > /etc/logrotate.d/$NAME.conf
/var/log/$NAME.log {
weekly
missingok
compress
delaycompress
notifempty
copytruncate
}
EOF
```
## Automated installation
```sh
wget 'https://raw.githubusercontent.com/GabLeRoux/debian-service-generator/master/new-service.sh' && bash new-service.sh
```
In this script I will download `service.sh` into a `tempfile`, replace some tokens, and then show you commands you should run as superuser.
If you feel confident enough with my script, you can `sudo` the script directly:
```sh
wget 'https://raw.githubusercontent.com/GabLeRoux/debian-service-generator/master/new-service.sh' && sudo bash new-service.sh
```
The script works offline so you can clone this repository and upload this script on your server and run it directly:
```sh
sudo bash new-service.sh
```
The script also handle parameters as showed below:
```sh
sudo bash new-service.sh "service_name" "description" "command to execute" "user which should run command"
```
### Demo
Creating the service:
Looking at service files (logs, pid):
Uninstalling service:
## LICENSE
[MIT](LICENSE.md) © [Gabriel Le Breton](https://gableroux.com)