New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #163

Open
wants to merge 13 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@sebuliba256
Copy link

sebuliba256 commented Feb 5, 2019

All Submissions:

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you added an explanation of what problem you are trying to solve with this PR?
  • Have you added information on what your changes do and why you chose this as your solution?
  • Have you written new tests for your changes?
  • Does your submission pass tests?
  • This project follows PEP8 style guide. Have you run your code against the 'flake8' linter?
@coveralls

This comment has been minimized.

Copy link

coveralls commented Feb 5, 2019

Coverage Status

Coverage remained the same at 81.91% when pulling f0af4f1 on sebuliba256:documentation into 2cb735c on IdentityPython:master.

2 similar comments
@coveralls

This comment has been minimized.

Copy link

coveralls commented Feb 5, 2019

Coverage Status

Coverage remained the same at 81.91% when pulling f0af4f1 on sebuliba256:documentation into 2cb735c on IdentityPython:master.

@coveralls

This comment has been minimized.

Copy link

coveralls commented Feb 5, 2019

Coverage Status

Coverage remained the same at 81.91% when pulling f0af4f1 on sebuliba256:documentation into 2cb735c on IdentityPython:master.

@coveralls

This comment has been minimized.

Copy link

coveralls commented Feb 5, 2019

Coverage Status

Coverage increased (+0.01%) to 81.92% when pulling de7e4cc on sebuliba256:documentation into 2cb735c on IdentityPython:master.

# pyffd -f --loglevel=DEBUG -p /var/run/pyffd.pid mdx.fd
# CACHE=-C

This comment has been minimized.

@leifj

leifj Feb 5, 2019

Collaborator

-C means turn off cache - maybe be clear about that in the text
I like that you're using env variables to enhance readability!

Show resolved Hide resolved docs/install.rst Outdated
Show resolved Hide resolved docs/install.rst Outdated
Show resolved Hide resolved docs/install.rst Outdated
pyFF requires five files which you should copy into the pyff-config directory

- A stylesheet in the *xsl* format

This comment has been minimized.

@leifj

leifj Feb 5, 2019

Collaborator

xslt stylesheets are not needed - only if you choose to use them in your pipeline and some of them are shipped with pyFF and can be referenced without copying them (eg tidy.xml). Refer to the xslt pipe documentation for details about how xslt files are located

pyFF requires five files which you should copy into the pyff-config directory

- A stylesheet in the *xsl* format
- A metadata signer certficate

This comment has been minimized.

@leifj

leifj Feb 5, 2019

Collaborator

there is a script in the scripts-directory for generating a signing key pair for demo purposes

This comment has been minimized.

@sebuliba256

sebuliba256 Feb 6, 2019

Author

If one uses the genkey script do they have to transfer the key pair to the pyff-config directory?

- A metadata signer certficate
- A metadata signer key
- A pipeline file in the *yaml* format
- A *xrd* file

This comment has been minimized.

@leifj

leifj Feb 5, 2019

Collaborator

xrd files are also not necessary - its just a way to represent a list of metadata URLs and their acoompanying signing certs but you could also do a load statement with multiple URL references... or a mix of xrd and URLs. There is also an (undocumented) way parser for so call MDSL files which are used in the eIDAS federation

sebuliba256 added some commits Feb 6, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment