nginxlinuxpath

package
v0.7.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 8, 2022 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultRoot           = "/etc/nginx"
	RootConfigName        = "nginx.conf"
	ConfigAvailableName   = "config-available"
	ConfigEnabledName     = "config-enabled"
	SitesBackup           = "sites-backup"
	SitesAvailableName    = "sites-available"
	SitesEnabledName      = "sites-enabled"
	ExtraConfName         = "conf.d"
	ModulesAvailableName  = "modules-available"
	ModulesEnabledName    = "modules-enabled"
	Users                 = "users"
	WildcardDotConfFilter = "*.conf"
	DefaultDirChmod       = filemode.DirDefault
)

Variables

View Source 
var (
	DefaultDirStructure = GetFullDirStructure(
		true,
		DefaultDirChmod,
		DefaultRoot)
)

Functions

func GetConf 

func GetConf() string

GetConf returns /etc/nginx/conf.d as a string

func GetFullDirStructure added in v0.1.2 

func GetFullDirStructure(
	isNormalize bool,
	dirChmod os.FileMode,
	currentNginxRoot string,
) *knowndirstructure.NginxApacheDirectory

func GetMimeTypes 

func GetMimeTypes() string

GetMimeTypes

returns /etc/nginx/mime.types as a string

func GetModulesAvailable 

func GetModulesAvailable() string

GetModulesAvailable 

returns /etc/nginx/modules-available as a string

func GetModulesEnabled 

func GetModulesEnabled() string

GetModulesEnabled 

returns /etc/nginx/modules-enabled as a string

func GetNormalizeFullDirStructure added in v0.1.2 

func GetNormalizeFullDirStructure(
	currentNginxRoot string,
) *knowndirstructure.NginxApacheDirectory

func GetSitesAvailable 

func GetSitesAvailable() string

GetSitesAvailable 

returns /etc/nginx/sites-available as a string

func GetSitesEnabled 

func GetSitesEnabled() string

GetSitesEnabled 

returns /etc/nginx/sites-enabled as a string

Types

type NginxDir added in v0.5.2 

type NginxDir struct {
	coreinstruction.BaseUsername
	Root, User            *knowndirstructure.NginxApacheDirectory
	SpecificUserRoot      string // /etc/nginx/conf.d/users/{user-name}
	AllUsersRoot          string // /etc/nginx/conf.d/users
	CurrentUserRootConfig string // /etc/nginx/conf.d/users/{user-name}/username.conf
	// contains filtered or unexported fields
}

func NewNginxDir added in v0.5.2 

func NewNginxDir(
	isNormalize bool,
	dirChmod os.FileMode,
	currentNginxRoot,
	username string,
) *NginxDir

func NewNginxDirDefaultChmod added in v0.6.3 

func NewNginxDirDefaultChmod(
	isNormalize bool,
	currentNginxRoot,
	username string,
) *NginxDir

func (*NginxDir) AbsPathOfAvailableSite added in v0.5.2 

func (it *NginxDir) AbsPathOfAvailableSite(siteName string) string

AbsPathOfAvailableSite

siteName : site-name

func (*NginxDir) AbsPathOfAvailableSiteAddConfExt added in v0.5.2 

func (it *NginxDir) AbsPathOfAvailableSiteAddConfExt(
	siteName string,
) string

func (*NginxDir) AbsPathOfEnabledSite added in v0.5.2 

func (it *NginxDir) AbsPathOfEnabledSite(siteName string) string

AbsPathOfEnabledSite

site : site-name

func (*NginxDir) AbsPathOfEnabledSiteAddConfExt added in v0.5.2 

func (it *NginxDir) AbsPathOfEnabledSiteAddConfExt(siteName string) string

func (*NginxDir) AllFilesAtAllUsersRoot added in v0.5.2 

func (it *NginxDir) AllFilesAtAllUsersRoot() *errstr.Results

func (*NginxDir) AllFilesAtSpecificUserRoot added in v0.5.2 

func (it *NginxDir) AllFilesAtSpecificUserRoot() *errstr.Results

func (*NginxDir) AllSiteFiles added in v0.5.2 

func (it *NginxDir) AllSiteFiles() ([]string, error)

func (*NginxDir) AllSiteFilesNoError added in v0.5.2 

func (it *NginxDir) AllSiteFilesNoError() []string

func (*NginxDir) AllUserEnabledSites added in v0.5.2 

func (it *NginxDir) AllUserEnabledSites() ([]string, error)

func (*NginxDir) AllUserEnabledSitesNoError added in v0.5.2 

func (it *NginxDir) AllUserEnabledSitesNoError() []string

func (*NginxDir) AllUsersDirs added in v0.5.2 

func (it *NginxDir) AllUsersDirs() *errstr.Results

AllUsersDirs

Get all dirs (full path collection) in NginxDir.AllUsersRoot

func (*NginxDir) AllUsersNames added in v0.5.2 

func (it *NginxDir) AllUsersNames() *errstr.Results

AllUsersNames

Only returns the usernames from dirs of NginxDir.AllUsersRoot

func (*NginxDir) AsJsonContractsBinder added in v0.5.3 

func (it *NginxDir) AsJsonContractsBinder() corejson.JsonContractsBinder

func (*NginxDir) AsJsoner added in v0.5.2 

func (it *NginxDir) AsJsoner() corejson.Jsoner

func (*NginxDir) CombinedAllUsersRoot added in v0.5.2 

func (it *NginxDir) CombinedAllUsersRoot(
	combinedPaths ...string,
) (
	first string,
	allCombinedPaths []string,
)

func (*NginxDir) CombinedSpecificUserRoot added in v0.5.2 

func (it *NginxDir) CombinedSpecificUserRoot(
	combinedPaths ...string,
) (
	first string,
	allCombinedPaths []string,
)

func (*NginxDir) CopyCurrentUserRootConfigTo added in v0.5.2 

func (it *NginxDir) CopyCurrentUserRootConfigTo(
	newLocation string,
) *errorwrapper.Wrapper

func (*NginxDir) CopyCurrentUserRootConfigToTempRel added in v0.5.2 

func (it *NginxDir) CopyCurrentUserRootConfigToTempRel(
	tempRelativePath string,
) *errstr.Result

CopyCurrentUserRootConfigToTempRel

Returns final copied path

func (*NginxDir) CurrentUserIncludeConfigRootFilePath added in v0.6.2 

func (it *NginxDir) CurrentUserIncludeConfigRootFilePath() string

CurrentUserIncludeConfigRootFilePath 

using format : userRootConfigFilePathFormat
sample : /etc/nginx/conf.d/users/{user-name}.conf

func (*NginxDir) CurrentUserRootConfigName added in v0.5.2 

func (it *NginxDir) CurrentUserRootConfigName() string

func (*NginxDir) DisableAllSites added in v0.5.2 

func (it *NginxDir) DisableAllSites() *errwrappers.Collection

func (*NginxDir) DisableSite added in v0.5.2 

func (it *NginxDir) DisableSite(siteName string) *errorwrapper.Wrapper

DisableSite disable a specific file, by removing symbolic link 

TODO: Disabling server will be complicated, if multiple servers
 present in same site file

func (*NginxDir) EnableSite added in v0.5.2 

func (it *NginxDir) EnableSite(siteName string) *errorwrapper.Wrapper

func (*NginxDir) EnableSiteAddConfExt added in v0.5.2 

func (it *NginxDir) EnableSiteAddConfExt(siteName string) *errorwrapper.Wrapper

func (*NginxDir) HasSiteFile added in v0.5.2 

func (it *NginxDir) HasSiteFile(site string) bool

func (*NginxDir) HasSiteFileAddConfExt added in v0.5.2 

func (it *NginxDir) HasSiteFileAddConfExt(site string) bool

func (*NginxDir) Json added in v0.5.2 

func (it *NginxDir) Json() corejson.Result

func (*NginxDir) JsonModelAny added in v0.5.2 

func (it *NginxDir) JsonModelAny() interface{}

func (*NginxDir) JsonParseSelfInject added in v0.5.3 

func (it *NginxDir) JsonParseSelfInject(jsonResult *corejson.Result) error

func (*NginxDir) JsonPtr added in v0.5.2 

func (it *NginxDir) JsonPtr() *corejson.Result

func (*NginxDir) JsonString added in v0.5.2 

func (it *NginxDir) JsonString() string

func (NginxDir) MkDir added in v0.5.2 

func (it NginxDir) MkDir(
	isCreateRootDir,
	isCreateSpecificUserDirOnly,
	isCreateBackup bool,
	mode os.FileMode,
) *errwrappers.Collection

func (NginxDir) MkDirAllUsersRoot added in v0.5.2 

func (it NginxDir) MkDirAllUsersRoot(mode os.FileMode) *errorwrapper.Wrapper

func (NginxDir) MkDirDefault added in v0.5.2 

func (it NginxDir) MkDirDefault(
	isCreateRootDir,
	isCreateSpecificUserDirOnly bool,
) *errwrappers.Collection

func (NginxDir) MkDirDefaultSpecific added in v0.5.2 

func (it NginxDir) MkDirDefaultSpecific() *errwrappers.Collection

func (NginxDir) MkDirSpecificUserRoot added in v0.5.2 

func (it NginxDir) MkDirSpecificUserRoot(mode os.FileMode) *errorwrapper.Wrapper

func (*NginxDir) RemoveAllUserSiteFiles added in v0.5.2 

func (it *NginxDir) RemoveAllUserSiteFiles() *errorwrapper.Wrapper

func (*NginxDir) SiteNameAddConfExt added in v0.5.2 

func (it *NginxDir) SiteNameAddConfExt(
	siteName string,
) string

func (*NginxDir) UserSitesAvailableDir added in v0.5.2 

func (it *NginxDir) UserSitesAvailableDir() string

UserSitesAvailableDir

Example : /etc/nginx/conf.d/users/username/sites-available

func (*NginxDir) UserSitesEnableDir added in v0.5.2 

func (it *NginxDir) UserSitesEnableDir() string

UserSitesEnableDir

Example : /etc/nginx/conf.d/users/username/sites-enabled

func (*NginxDir) UsersAvailableSites added in v0.5.2 

func (it *NginxDir) UsersAvailableSites() *errstr.Results

func (*NginxDir) UsersAvailableSitesGlobConf added in v0.5.2 

func (it *NginxDir) UsersAvailableSitesGlobConf() string

UsersAvailableSitesGlobConf

gives something like : /etc/nginx/conf.d/users/username/sites-available/*.conf

func (*NginxDir) UsersConfigGlob added in v0.5.2 

func (it *NginxDir) UsersConfigGlob() string

UsersConfigGlob gives the /etc/nginx/conf.d/users/*.conf

func (*NginxDir) UsersEnabledGlobConf added in v0.5.2 

func (it *NginxDir) UsersEnabledGlobConf() string

UsersEnabledGlobConf

gives something like : /etc/nginx/conf.d/users/username/sites-enabled/*.conf

func (*NginxDir) UsersEnabledSites added in v0.5.2 

func (it *NginxDir) UsersEnabledSites() *errstr.Results

func (*NginxDir) WriteUserRootEnableIncludeConfigFile added in v0.6.2 

func (it *NginxDir) WriteUserRootEnableIncludeConfigFile(
	dirChmod, fileChmod os.FileMode,
) *errorwrapper.Wrapper

WriteUserRootEnableIncludeConfigFile 

Writes enable config file to file system for the specific user.
It will write user root config, include statement only

Content Sample:

  • includeFormatted : "include /etc/nginx/conf.d/users/{username}/enabled/*.conf;"

Default file location:

  • CurrentUserIncludeConfigRootFilePath() : "/etc/nginx/conf.d/users/{user-name}.conf"

Reference:

func (*NginxDir) WriteUserRootEnableIncludeConfigFileDefaultChmod added in v0.6.2 

func (it *NginxDir) WriteUserRootEnableIncludeConfigFileDefaultChmod() *errorwrapper.Wrapper

WriteUserRootEnableIncludeConfigFileDefaultChmod 

Writes enable config file to file system for the specific user
using WriteUserRootEnableIncludeConfigFile

DefaultChmod:

  • DefaultDirChmod, filemode.FileDefault

type NginxDirMap added in v0.5.7 

type NginxDirMap struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewNginxDirMap added in v0.5.7 

func NewNginxDirMap(configRoot string) *NginxDirMap

func NewNginxDirMapCap added in v0.5.7 

func NewNginxDirMapCap(configRoot string, capacity int) *NginxDirMap

func (*NginxDirMap) AddOrUpdate added in v0.5.7 

func (it *NginxDirMap) AddOrUpdate(key string, nginxDir *NginxDir) *NginxDir

func (*NginxDirMap) AddOrUpdateLock added in v0.5.7 

func (it *NginxDirMap) AddOrUpdateLock(key string, nginxDir *NginxDir) *NginxDir

func (*NginxDirMap) ClearAll added in v0.5.7 

func (it *NginxDirMap) ClearAll()

func (*NginxDirMap) ClearAllLock added in v0.5.7 

func (it *NginxDirMap) ClearAllLock()

func (*NginxDirMap) Count added in v0.5.7 

func (it *NginxDirMap) Count() int

func (*NginxDirMap) DeleteKey added in v0.5.7 

func (it *NginxDirMap) DeleteKey(key string)

func (*NginxDirMap) DeleteKeyLock added in v0.5.7 

func (it *NginxDirMap) DeleteKeyLock(key string)

func (*NginxDirMap) GetSet added in v0.6.6 

func (it *NginxDirMap) GetSet(
	isNormalize bool,
	dirChmod os.FileMode,
	userName string,
) *NginxDir

func (*NginxDirMap) GetSetDefault added in v0.6.6 

func (it *NginxDirMap) GetSetDefault(
	isNormalize bool,
	userName string,
) *NginxDir

func (*NginxDirMap) GetSetDefaultLock added in v0.6.6 

func (it *NginxDirMap) GetSetDefaultLock(
	isNormalize bool,
	userName string,
) *NginxDir

func (*NginxDirMap) GetSetLock added in v0.6.6 

func (it *NginxDirMap) GetSetLock(
	isNormalize bool,
	dirChmod os.FileMode,
	userName string,
) *NginxDir

func (*NginxDirMap) HasAnyItem added in v0.5.7 

func (it *NginxDirMap) HasAnyItem() bool

func (*NginxDirMap) HasAnyItemLock added in v0.5.7 

func (it *NginxDirMap) HasAnyItemLock() bool

func (*NginxDirMap) HasIndex added in v0.5.7 

func (it *NginxDirMap) HasIndex(index int) bool

func (*NginxDirMap) HasKey added in v0.5.7 

func (it *NginxDirMap) HasKey(key string) bool

func (*NginxDirMap) IsEmpty added in v0.5.7 

func (it *NginxDirMap) IsEmpty() bool

func (*NginxDirMap) IsEmptyLock added in v0.5.7 

func (it *NginxDirMap) IsEmptyLock() bool

func (*NginxDirMap) IsMissingKey added in v0.5.7 

func (it *NginxDirMap) IsMissingKey(key string) bool

func (*NginxDirMap) Keys added in v0.5.7 

func (it *NginxDirMap) Keys() []string

func (*NginxDirMap) KeysSorted added in v0.5.7 

func (it *NginxDirMap) KeysSorted() []string

func (*NginxDirMap) LastIndex added in v0.5.7 

func (it *NginxDirMap) LastIndex() int

func (*NginxDirMap) Length added in v0.5.7 

func (it *NginxDirMap) Length() int

func (*NginxDirMap) LengthLock added in v0.5.7 

func (it *NginxDirMap) LengthLock() int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.