Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
slash
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
uplex-varnish
slash
Commits
ab85f6a5
Unverified
Commit
ab85f6a5
authored
Mar 20, 2023
by
Nils Goroll
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve documentation based on user feedback
Closes #4
parent
f24a9536
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
58 additions
and
0 deletions
+58
-0
vmod_slash.man.rst
src/vmod_slash.man.rst
+29
-0
vmod_slash.vcc
src/vmod_slash.vcc
+29
-0
No files found.
src/vmod_slash.man.rst
View file @
ab85f6a5
...
...
@@ -439,6 +439,18 @@ block devices reside (e.g. on ``/dev/``). The environment variable
``slash_fellow_options`` can be set to contain ``skip-path-check``
where, for whatever exotic reason, this check needs to be skipped.
.. _jail: https://varnish-cache.org/docs/trunk/reference/varnishd.html#jail
Permissions and ownership on *path* need to be set such that the
``varnishd`` worker process has read/write access (see ``workuser`` in
the `jail`_ option documentation). On a system where ``varnishd``
starts as root with the default unix jail configuration (``vcache``
workuser), the permissions can be set using::
my_fellow_path=... # REPLACE ... with path
chown vcache $my_fellow_path
chmod 600 $my_fellow_path
When a VCL-defined fellow storage goes out of scope because the last
VCL referencing it is discarded, all of its objects are removed from
the cache, but remain on disk. They can be loaded again by configuring
...
...
@@ -815,6 +827,23 @@ with :ref:`varnishlog(1)`::
During startup, additional diagnostic information is written to
standard error (stderr).
Explanation of some commonly seen startup errors:
* ``open(...) failed: Permission denied``
Permissions on the storage path are not set correctly. See
`slash.fellow()` for how to set them.
* ``... is not a fellow file``
The first 4KB of the storage path are neither zero nor written by
fellow. This is a safeguard in order to avoid overwriting
potentially precious data. Either recreate the file/device or
overwrite the first 4KB with zeroes (as always, entirely at your own
risk, replace ``...`` with the fellow path)::
dd if=/dev/zero of=... bs=4096 count=1
FELLOW CACHE LOADING
====================
...
...
src/vmod_slash.vcc
View file @
ab85f6a5
...
...
@@ -385,6 +385,18 @@ block devices reside (e.g. on ``/dev/``). The environment variable
``slash_fellow_options`` can be set to contain ``skip-path-check``
where, for whatever exotic reason, this check needs to be skipped.
.. _jail: https://varnish-cache.org/docs/trunk/reference/varnishd.html#jail
Permissions and ownership on *path* need to be set such that the
``varnishd`` worker process has read/write access (see ``workuser`` in
the `jail`_ option documentation). On a system where ``varnishd``
starts as root with the default unix jail configuration (``vcache``
workuser), the permissions can be set using::
my_fellow_path=... # REPLACE ... with path
chown vcache $my_fellow_path
chmod 600 $my_fellow_path
When a VCL-defined fellow storage goes out of scope because the last
VCL referencing it is discarded, all of its objects are removed from
the cache, but remain on disk. They can be loaded again by configuring
...
...
@@ -736,6 +748,23 @@ with :ref:`varnishlog(1)`::
During startup, additional diagnostic information is written to
standard error (stderr).
Explanation of some commonly seen startup errors:
* ``open(...) failed: Permission denied``
Permissions on the storage path are not set correctly. See
`slash.fellow()` for how to set them.
* ``... is not a fellow file``
The first 4KB of the storage path are neither zero nor written by
fellow. This is a safeguard in order to avoid overwriting
potentially precious data. Either recreate the file/device or
overwrite the first 4KB with zeroes (as always, entirely at your own
risk, replace ``...`` with the fellow path)::
dd if=/dev/zero of=... bs=4096 count=1
FELLOW CACHE LOADING
====================
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment