giuliano1993/serverman

Easily manage all your servers from command line

  _____
 / ____|
| (___   ___ _ ____   _____ _ __ _ __ ___   __ _ _ __
 \___ \ / _ \ '__\ \ / / _ \ '__| '_ ` _ \ / _` | '_ \
 ____) |  __/ |   \ 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 first. For any further doubt don't hesitate to contact me! Issues and features ideas are welcome!

• Installation
• Configuration
  • Digital Ocean
    • doAuthToken
    • localKeyFile
    • sshKey
  • GitHub
    • GitUser
    • GitToken
  • Netlify
    • NetlifyUser
    • NetlifyToken
    • GithubInstallation
  • Vercel
    • vercelToken

Installation

To install ServerMan locally just open a terminal and run:

npm i -g ghostylab/serverman@latest

then to use it you can run

sm

or

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

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. 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

---

Netlify

NetlifyUser

• Your Netlify username

NetlifyToken

• Your Netlify Token. You can get one by going here

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 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 click on configure and copy the number appended at the end of the URL.

---

Vercel

vercelToken

• Your Vercel Token

serverman's Issues

Add the possibility to choose a commands flow for Digital ocean droplets setup, if you don't wanna use the default one

Document the functions for Netlify

Allow to choose nginx or apache as default web server when creating a Digital ocean droplet

In the configurations fix the undefined in the ssh key path taht shows instead of the active user

Open the configs ( first time or from the config option in the main menu )
If it's first time: Select Digital Ocean > Local Key Path
if it's from the menu just select Local Key Path

When creating a site for digital ocean add the possibility to scroll your github repos

At the moment when i choose a repo to deploy on digital ocean I have to write down the repo name!
I want to download the repo list instead e allow the user to select from the list

Convert the project to typescript

• convert init
• convert commands lists
• convert single functions file
• convert utilities

ADD README.md

Make the package globally installable

Document the functions for Digital Ocean

Add options to the base command to make less steps in inquirer

add at least
--digital-ocean
--netlify
--vercel

for choosing directly the provider

--name -> for choosing the site name
--list -> directly opening the list

Document the functions for Vercel

Add the possibility to change the default configuration when deployn on Netlify

at the moment Netlify options sent to API to deploy a project are somehow hardcoded: the options are mostly in the direction of a vue project. But we need to have the possibility to change some of them, specifically:

{
      "branch": repo['default_branch'],
      "cmd": "npm run build",
      "dir": "dist/",
      "private": false,
}

these are mostly default commands and directives but could change at times,
branch: is the branches to deploy when it has got pushes or PR
**cmd: ** is the build command
dir is the directory where the built projects is
private check for the private repositories

We should ask some question thanks to inquirer in order to allow this value to be set (the values should default to the ones already in)

Allow custom build command on Vercel project

Add default Nxgin configuration

Write Contributing file

Add the possibility to choose also application images, instead of distibutions,

Choosing application images, the user shall be able to choose if they want to directly deploy a droplet with laravel or Wordpress or elastic search or other services on it

Allow to write a local config which is readable by the package

We need to allow configuration so the user can insert all the information needed to make the tool work
we need:

• Post install script which allow to insert the information in a file saved in the folder
• a configuration option in the menu which allows to check and write the missing informations

When finishing the configuration at the first access, shouldn't exit the process but get you to the main menu

At this time, when the configuration process is done, selecting skip cause exiting the program. We should change that and going on skip should run the init function to actually start the program

Add Biome

Can't automatically access via ssh after server creation

While in python version it was possible, to make it all in once, now I have to make another call to the program to instal the needed packages on the server

[ porting ] Porting of netlify new project from servermanPy repo

In Python version i created also the netlify website trough my commandline.
Next step then is porting that functionality in node version

Add possnility to create SSH key in place also when creating a Digital Ocean Server

At th moment we are only able to create an SSH key when we create a site on netlify. It would be nice to create custom SSH keys when we build a Digital Ocean Server which works with that server alone. It would be more secure and we shouldn't store the key in the config file.

Implement control for common errors

• implement a check on returned status
• implement a check before the requests, to be sure all required keys ant tokens are set before making a request

Add Control on project name on Vercel, only lowercase characters

Add documentation about working with DigitalOcean and SSH keys

Create documentation table for the options available in the configs

Create documentation table for the options available in the configs and a short description for each

Copy paste doesn't work properly when in the application

If you try to paste something, you need to ctrl-v and then do the right click. This gets pretty annoying especially when you ssh into your servers and if yo perform some sudo action can't say if you've pasted your password or not.

Add a command for Digital Ocean to check what sites are hosted on a single droplet

Improve docs and readme