linkulator2/README.md

1.6 KiB

Linkulator, a link aggregator for the shell

Installation

Just clone this repo into any location in users' paths. Each user can have their own copy, in case they want to customize it, or you can install a central version in /usr/local/bin.

On most systems, the default configurations should just work (tm), but follow the config steps below if not.

Configuration

Default Path settings

These options can be found in config.py in the class DefaultPaths

User home directory location

String all_homedir_pattern

Customise user home directory hierarchy. Default is /home/*/ to support a standard structure like /home/username/

For example, you may have home directories in a location like /userdata/(first letter)/(username) i.e. /userdata/a/auser. The glob pattern would need to be updated to /userdata/i*/*/

Data directory name

String datadir

Customise the name of the directory where user data is stored. Default is .linkulator.

Data file

String datafile

Customise the name of the file where user links and replies are stored. Default is linkulator.data

Ignore file

String ignorefile

Customise the name of the file where ignored users are stored. Default is ignore

Settings file

String settingsfile

Customise the name of the file where user settings are stored. Default is linkulatorrc

Default User settings

These options can be found in config.py in the class DefaultUser

Default browser

String browser

Customise the command used to execute the default browser used by linkulator. Default is lynx