Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giuliano1993/serverman
Easily manage all your servers from command line
https://github.com/giuliano1993/serverman
Last synced: 19 days ago
JSON representation
Easily manage all your servers from command line
- Host: GitHub
- URL: https://github.com/giuliano1993/serverman
- Owner: Giuliano1993
- License: mit
- Created: 2023-10-10T04:06:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-01T00:41:37.000Z (3 months ago)
- Last Synced: 2024-10-09T04:43:07.269Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 237 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
```
_____
/ ____|
| (___ ___ _ ____ _____ _ __ _ __ ___ __ _ _ __
\___ \ / _ \ '__\ \ / / _ \ '__| '_ ` _ \ / _` | '_ \
____) | __/ | \ V / __/ | | | | | | | (_| | | | |
|_____/ \___|_| \_/ \___|_| |_| |_| |_|\__,_|_| |_|
```
**Serverman** is a comprehensive tool for managing your servers across different platforms directly from your terminal.
At the moment the tool can handle **DigitalOcean** Server Creation and Sites addition, and deploying Github repos on **Netlify** and **Vercel**.
If you want to contribute to this project, please read the [Contributing file](./CONTRIBUTING.md) first. For any further doubt don't hesitate to contact me!
Issues and features ideas are welcome!
- [Installation](#installation)
- [Configuration](#configuration)
- [Digital Ocean](#digital-ocean)
- [doAuthToken](#doauthtoken)
- [localKeyFile](#localkeyfile)
- [sshKey](#sshkey)
- [GitHub](#github)
- [GitUser](#gituser)
- [GitToken](#gittoken)
- [Netlify](#netlify)
- [NetlifyUser](#netlifyuser)
- [NetlifyToken](#netlifytoken)
- [GithubInstallation](#githubinstallation)
- [Vercel](#vercel)
- [vercelToken](#verceltoken)
## Installation
To install ServerMan locally just open a terminal and run:
```bash
npm i -g ghostylab/serverman@latest
```
then to use it you can run
```bash
sm
```
or
```bash
serverman
```
---
## Configuration
The first time you'll run serverman you'll be asked to provide some configurations.
Don't worry if you don't have everything at your first run, you can always access and edit your configs later
---
### Digital Ocean
#### doAuthToken
- Your Digital Ocean Token. You can get it [here](https://cloud.digitalocean.com/account/api/tokens?i=75bc4f)
#### localKeyFile
- the path to your ssh key (necessary for ssh your way to the server)
#### sshKey
- your Ssh key fingerprint. You can either use an already exsisting key or creating a new one. To add a new ssh key from your computer to Digital Ocean's recognized keys you can go [here](https://cloud.digitalocean.com/account/security?i=75bc4f). You can then ad the fingerprint to your config.
---
### GitHub
#### GitUser
- Your github username
#### GitToken
- Your Github Token. You can get one by going [here](https://github.com/settings/tokens)
---
### Netlify
#### NetlifyUser
- Your Netlify username
#### NetlifyToken
- Your Netlify Token. You can get one by going [here](https://github.com/settings/tokens)
#### GithubInstallation
- Your Netlify Installation ID on github.
If you wish to use ServerMan to create sites on netlify you will need to connect Netlify and github manually and save the installation ID.
To create you connection between Netlify and github you just need to go on [netlify user settings](https://app.netlify.com/user/settings) and configure the connection with your github account (grant access to all the repos to easily deploy further projects).
After doing this you can con on [Github Application settings](https://github.com/settings/installations) click on configure and copy the number appended at the end of the URL.
---
### Vercel
#### vercelToken
- Your Vercel Token