Skip to content

Commit

Permalink
add github pages documentation site
Browse files Browse the repository at this point in the history
  • Loading branch information
Gustavo Marin committed Apr 2, 2020
1 parent 5460f95 commit ff3bdbe
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 302 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/gh-pages.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: github pages

on:
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
ref: docs
with:
submodules: true

- name: Get contributors
uses: actions/checkout@v2
run: |
git checkout master -- .all-contributorsrc
cp .all-contributorsrc docs/data/contributors.json
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.68.3'
extended: true

- name: Build
run: |
cd docs
hugo --minify --enableGitInfo
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/public
force_orphan: true
enable_jekyll: true
publish_branch: gh-pages
3 changes: 2 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
dist
hostctl
hostctl.exe
homebrew-tap
.etchosts
docs/public
291 changes: 17 additions & 274 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,86 +17,6 @@ This tool gives you more control over the use of your `hosts` file. You can have

It is a tedious task to handle the `hosts` file by editing manually. With this tool you can automate some aspects to do it cleaner and quick.

## Table of content
<details>
<summary>expand</summary>

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Sample Usage](#sample-usage)
- [Installation](#installation)
- [Pre-built binary](#pre-built-binary)
- [Arch Linux](#arch-linux)
- [HomeBrew](#homebrew)
- [Snap](#snap)
- [Scoop](#scoop)
- [Features](#features)
- [Linux/Mac/Windows and permissions](#linuxmacwindows-and-permissions)
- [Usage](#usage)
- [List profiles](#list-profiles)
- [Add new profile from a file](#add-new-profile-from-a-file)
- [Add new profile from cli](#add-new-profile-from-cli)
- [Enable/Disable profile](#enabledisable-profile)
- [Remove a profile](#remove-a-profile)
- [Backup hosts file](#backup-hosts-file)
- [Restore a hosts file](#restore-a-hosts-file)
- [TODO](#todo)
- [References](#references)
- [Contributing](#contributing)
- [Contributors ✨](#contributors-)
- [LICENSE](#license)
- [Author(s)](#authors)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
</details>


## Sample Usage
![sample usage](docs/hostctl.gif)


## Installation

### Pre-built binary

Go to [release page](https://github.com/guumaster/hostctl/releases) and download the binary you need.


### Arch Linux

`hostctl` has an AUR package: <https://aur.archlinux.org/packages/hostctl/>.
You can install it using your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) of choice.

Example:
```bash
yay -Sy hostctl
```


### HomeBrew

`brew install guumaster/tap/hostctl`


### Snap

**WARNING**: Still working out a permission issue * [ hostctl snap - store-requests](https://forum.snapcraft.io/t/plugs-system-files-for-hostctl-snap/16199/5)

`[sudo] snap install hostctl`


### Scoop

```
scoop bucket add hostctl https://github.com/guumaster/hostctl.git
scoop install hostctl
```

*NOTE*: If you also installed `sudo` with Scoop, you can run the examples below with `sudo` instead of starting your terminal as administrator.



## Features

Expand All @@ -106,212 +26,34 @@ scoop install hostctl
* add profiles directly from a `.etchosts` file that you can add to your vcs.


## Linux/Mac/Windows and permissions
## Documentation

The tool recognize your system and use the right hosts file, it will use `/etc/hosts` on Linux/Mac and `C:/Windows/System32/Drivers/etc/hosts` on Windows.
Read the [Getting started guide](http://guumaster.github.io/hostctl/getting-started)
or check full documentation [here](http://guumaster.github.io/hostctl).

**SUDO/ADMIN**: You will need permissions for any action that modify hosts file, add `sudo` to the commands below when needed. If you are on windows, make sure you run it as administrator.

**WARNING**: it should work on any system. It's tested on Ubuntu and Windows 10. If you can confirm it works on other system, please let me know [here](https://github.com/guumaster/hostctl/issues/new).



## Usage

```
_ _ _____ _______ _______ _______ _______
|_____| | | |______ | | | |
| | |_____| ______| | |_____ | |_____
hostctl is a CLI tool to manage your hosts file with ease.
You can have multiple profiles, enable/disable exactly what
you need each time with a simple interface.
Usage:
hostctl [command]
Available Commands:
add Add content to a profile in your hosts file.
backup Creates a backup copy of your hosts file
disable Disable a profile from your hosts file.
enable Enable a profile on your hosts file.
help Help about any command
list Shows a detailed list of profiles on your hosts file.
remove Remove a profile from your hosts file.
restore Restore hosts file content from a backup file.
set Set content to a profile in your hosts file.
Flags:
-h, --help help for hostctl
--host-file string Hosts file path (default "/etc/hosts")
-p, --profile string Choose a profile
Use "hostctl [command] --help" for more information about a command.
```

### List profiles

`$> hostctl list`

```
// Output:
+---------+--------+----------------+----------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+----------------+----------------------------+
| default | on | 127.0.0.1 | localhost |
| default | on | 127.0.1.1 | some-existing.local |
| default | on | ::1 | ip6-localhost |
+---------+--------+----------------+----------------------------+
| lite | on | 192.168.1.51 | jupyter.toolkit-lite.local |
+---------+--------+----------------+----------------------------+
| toolkit | on | 192.168.99.119 | app.toolkit.local |
| toolkit | on | 192.168.99.119 | gitea.toolkit.local |
| toolkit | on | 192.168.99.119 | jupyter.toolkit.local |
+---------+--------+----------------+----------------------------+
```

### Add new profile from a file

You can store routing as a separate file and add it to the global hosts file when you need.

Say you have this routing file on any of your projects:

```
# File stored in /path/to/some/project/.etchosts
127.0.0.1 web.my-awesome-project.local
127.0.0.1 api.my-awesome-project.local
```

You can add that content as a profile with this command:

`$>hostctl set -p awesome --from /path/to/some/project/.etchosts `

```
// Output:
+---------+--------+----------------+------------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+----------------+------------------------------+
| default | on | 127.0.0.1 | localhost |
| default | on | 127.0.1.1 | some-existing.local |
| default | on | ::1 | ip6-localhost |
+---------+--------+----------------+------------------------------+
| another | on | 192.168.1.51 | jupyter.toolkit-lite.local |
+---------+--------+----------------+------------------------------+
| awesome | on | 127.0.0.1 | web.my-awesome-project.local |
| awesome | on | 127.0.0.1 | api.my-awesome-project.local |
+---------+--------+----------------+------------------------------+
```

### Add new profile from cli

You can add a new profile or add new domain to a specific profile directly from the cli:

You can add that content as a profile with this command:

`$>hostctl -p test add domains test.com --ip 123.123.123.123 `

```
// Output:
+---------+--------+-----------------+------------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+-----------------+------------------------------+
| default | on | 127.0.0.1 | localhost |
| default | on | 127.0.1.1 | some-existing.local |
| default | on | ::1 | ip6-localhost |
+---------+--------+-----------------+------------------------------+
| another | on | 192.168.1.51 | jupyter.toolkit-lite.local |
+---------+--------+-----------------+------------------------------+
| test | on | 123.123.123.123 | test.com |
+---------+--------+-----------------+------------------------------+
```

### Enable/Disable profile

You can enable/disable any profile, the routing will react to it state.
Disabling a profile does not remove the content from the hosts file, this way you can re-enable it later on.

`$> hostctl disable -p awesome`
```
// Output:
+---------+--------+----------------+------------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+----------------+------------------------------+
...
+---------+--------+----------------+------------------------------+
| awesome | off | 127.0.0.1 | web.my-awesome-project.local |
| awesome | off | 127.0.0.1 | api.my-awesome-project.local |
+---------+--------+----------------+------------------------------+
```

`$> hostctl enable -p awesome`
```
// Output:
+---------+--------+----------------+------------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+----------------+------------------------------+
...
+---------+--------+----------------+------------------------------+
| awesome | on | 127.0.0.1 | web.my-awesome-project.local |
| awesome | on | 127.0.0.1 | api.my-awesome-project.local |
+---------+--------+----------------+------------------------------+
```

### Remove a profile

If you want to completely remove a profile from the hosts file you can run:

`$> hostctl remove -p awesome`

```
// Output:
+---------+--------+----------------+------------------------------+
| PROFILE | STATUS | IP | DOMAIN |
+---------+--------+----------------+------------------------------+
| default | on | 127.0.0.1 | localhost |
| default | on | 127.0.1.1 | some-existing.local |
| default | on | ::1 | ip6-localhost |
+---------+--------+----------------+------------------------------+
| another | off | 192.168.1.51 | jupyter.toolkit-lite.local |
+---------+--------+----------------+------------------------------+
```

### Backup hosts file

You can save a copy of your hosts file with this command:

`hostctl backup --path /tmp/`

It would create a file `/tmp/hosts.20200314` with the content of your hosts file.
## Sample Usage
![sample usage](docs/hostctl.gif)


### Restore a hosts file
## Installation

You can restore a previous backup of your hosts file with this command:

`hostctl restore --from /tmp/hosts.20200314`
Go to [release page](https://github.com/guumaster/hostctl/releases) and download the binary you need.

It would **overwrite** your hosts file with the content of your backup.
Or read how to install on your system [here](http://guumaster.github.io/hostctl/installation/)


### References
## Linux/Mac/Windows and permissions

* Dependencies:
* [spf13/cobra](https://github.com/spf13/cobra)
* [guumaster/tablewriter](https://github.com/guumaster/tablewriter)
The tool recognize your system and use the right hosts file, it will use `/etc/hosts` on Linux/Mac and `C:/Windows/System32/Drivers/etc/hosts` on Windows.

* Inspiration:
* [txn2/txeh: CLI for /etc/hosts management](https://github.com/txn2/txeh)
**SUDO/ADMIN**: You will need permissions for any action that modify hosts file, add `sudo` to the commands below when needed. If you are on windows, make sure you run it as administrator.

**WARNING**: it should work on any system. It's tested on Ubuntu and Windows 10. If you can confirm it works on other system, please let me know [here](https://github.com/guumaster/hostctl/issues/new).

## Contributing

Be sure to read [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).

Pull requests are welcome.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests if your code affects existing tests.


## Contributors ✨
Expand All @@ -338,14 +80,15 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!


## LICENSE
## Author(s)

[MIT license](LICENSE)
* [guumaster](https://github.com/guumaster)


## Author(s)
## LICENSE

[MIT license](LICENSE)

* [guumaster](https://github.com/guumaster)



Expand Down
5 changes: 2 additions & 3 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module github.com/guumaster/hostctl
go 1.14

require (
github.com/guumaster/tablewriter v0.0.4-separator
github.com/mattn/go-runewidth v0.0.8 // indirect
github.com/spf13/cobra v0.0.6
github.com/guumaster/tablewriter v0.0.6
github.com/spf13/cobra v0.0.7
)
Loading

0 comments on commit ff3bdbe

Please sign in to comment.