Skip to content

Commit

Permalink
Removes postinstall script from aur and updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
SaahilNotSahil committed Aug 28, 2023
1 parent c00a135 commit 75831a5
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 18 deletions.
2 changes: 0 additions & 2 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ aurs:
install -Dm755 "./scripts/linux/login.sh" "${pkgdir}/usr/bin/autoproxylogin"
install -Dm755 "./scripts/linux/daemon-start.sh" "${pkgdir}/usr/bin/autoproxyd-start"
install -Dm755 "./scripts/linux/daemon-stop.sh" "${pkgdir}/usr/bin/autoproxyd-stop"
install -Dm755 "./aur-post-install.install" "${pkgdir}/../../aur-post-install.install"
install -Dm644 "./LICENSE" "${pkgdir}/usr/share/licenses/iitj-autoproxy/LICENSE"
install -Dm644 "./base_config.json" "${pkgdir}/etc/iitj-autoproxy/autoproxy.config"
install -Dm644 "./README.md" "${pkgdir}/usr/share/doc/iitj-autoproxy/README.md"
Expand All @@ -96,4 +95,3 @@ archives:
- README.md
- base_config.json
- scripts/*
- aur-post-install.install
69 changes: 68 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,78 @@ A CLI tool to automatically login to IIT Jodhpur's network firewall.

#### (Currently only supports Linux)

### Installation (Debian-based Linux Distributions only)
### Installation

#### Debian-based Linux Distributions:
- Run the following commands to install the package:

```
$ curl -s https://packagecloud.io/install/repositories/XanderWatson/iitj-autoproxy/script.deb.sh | sudo bash
$ sudo apt update
$ sudo apt install iitj-autoproxy
```

- The daemon service will be started automatically. Incase it doesn't, run the following command:

```
$ sudo autoproxyd-start
```

- To stop the daemon service, run the following command:

```
$ sudo autoproxyd-stop
```

#### Arch-based Linux Distributions:
- Install the [AUR package](https://aur.archlinux.org/packages/iitj-autoproxy-bin/) using your favourite AUR helper.

For example, using `yay`:
```
$ yay -S iitj-autoproxy-bin
```

- Start the daemon service:

```
$ sudo autoproxyd-start
```

- To stop the daemon service, run the following command:

```
$ sudo autoproxyd-stop
```

### Usage

- First, you need to set your username and password. To do so, run the following command:

```
$ autoproxy config
```

- Enter your username and password when prompted.


- To login to the firewall once, run the following command:

```
$ autoproxy login
```

- To automatically login to the firewall everytime it is required, run the following command:

```
$ autoproxy schedule
```

Note: You need to be logged out before running the above command.

- To logout from the firewall, run the following command:

```
$ autoproxy logout
```

#### Support for other operating systems coming soon :)
15 changes: 0 additions & 15 deletions aur-post-install.install

This file was deleted.

0 comments on commit 75831a5

Please sign in to comment.