Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sdarwin committed Apr 26, 2024
1 parent 290b73e commit e321b4a
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Ansible-VNC

Installs and configures VNC Server/Desktop. By default, this will be TigerVNC and Gnome. However, you may easily select from a few others including
Installs and configures VNC Server/Desktop. By default, this will be TigerVNC and Gnome. However, you may easily select from a few others including

VNC Servers: TigerVNC, TightVNC, vnc4server
Desktops: Gnome, Xfce4
Operating Systems: Ubuntu, Debian, Redhat, Centos
VNC Servers: TigerVNC, TightVNC, vnc4server
Desktops: Gnome, Xfce4
Operating Systems: Ubuntu, Debian, Redhat, Centos

## Requirements

A recent version of Linux, see meta/main.yml.
A recent version of Linux, see meta/main.yml.

## Example Playbook

An example playbook is included at default.yml in the root directory. To run it:
An example playbook is included at default.yml in the root directory. To run it:

ansible-playbook default.yml
ansible-playbook default.yml

## Instructions

Copy the contents of defaults/main.yml to your local groups_vars/all and modify as necessary. Review each variable carefully. This serves as the "config file", so by customizing the default variables you adjust the installation. At minimum, the vnc_users variable in that file should likely be set for your particular environment. The other settings are optional.
Copy the contents of defaults/main.yml to your local groups_vars/all and modify as necessary. Review each variable carefully. This serves as the "config file", so by customizing the default variables you adjust the installation. At minimum, the vnc_users variable in that file should likely be set for your particular environment. The other settings are optional.

Review the documentation included in this repo:<br/>
docs/admin-guide.md<br/>
docs/users-guide.md<br/>
Review the documentation included in this repo:<br/>
docs/admin-guide.md<br/>
docs/users-guide.md<br/>

## Quickstart

Most of the instructions assume a standard Ansible infrastructure.
Most of the instructions assume a standard Ansible infrastructure.

However, if you have just launched a single new remote test server, and would like to very quickly install VNC without much setup or configuration:
However, if you have just launched a single new remote test server, and would like to very quickly install VNC without much setup or configuration:

```
curl -sL https://raw.githubusercontent.com/sdarwin/Ansible-VNC/master/scripts/quickinstall.sh | sudo bash
Expand All @@ -41,5 +41,3 @@ GPLv2
## Author Information

By Sam Darwin, 2018. Feedback and bug reports welcome.

[![Analytics](https://ga-beacon.appspot.com/UA-112361697-1/Ansible-VNC)](https://github.com/igrigorik/ga-beacon)

0 comments on commit e321b4a

Please sign in to comment.