aboutsummaryrefslogtreecommitdiffstats
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeLines
* Use 'executable' over 'binary' to be clearer as to what is supportedGravatar Chris Lovering2024-10-05-2/+2
|
* Correct spelling errorsGravatar ChrisJL2024-10-05-1/+1
| | | Co-authored-by: Mark <[email protected]>
* Add a note about multi-verison support to the READMEGravatar Chris Lovering2024-10-03-0/+10
|
* Update all references to /lang to /snekbinGravatar Chris Lovering2024-10-03-1/+1
|
* Fix link in readme (#189)Gravatar wookie1842023-08-30-1/+1
|
* Install multiple Python versions in imageGravatar Mark2023-08-19-8/+4
| | | | | | | | Separate snekbox's Python interpreter from the interpreter used by NsJail. This allows for the interpreters to be updated on different cadences and provides better isolation of packages. Each Python interpreter adds about 70 MB to the built image.
* Fix actions status badgeGravatar wookie1842023-06-22-2/+2
|
* Update readme regarding default output path and last modified checkGravatar Ionite2023-03-02-6/+4
|
* Update README punctuationGravatar Ionite2022-12-04-1/+1
| | | Co-authored-by: Mark <[email protected]>
* Remove readme implementation detailsGravatar ionite342022-12-04-7/+1
|
* Remove link to api schema infoGravatar ionite342022-12-04-2/+0
|
* Format readme newlinesGravatar ionite342022-12-04-10/+4
|
* Add new file system info to READMEGravatar ionite342022-11-28-1/+36
|
* Mention output limit can be customised and fix link in README.mdGravatar Mark2022-06-07-2/+2
|
* Rename DEBUG env var to SNEKBOX_DEBUGGravatar Mark2022-06-06-1/+1
| | | | | Use a more unique name to avoid accidentally using the value of a similar env var that was set for an unrelated reason.
* Remove env var support for NsJail argsGravatar Mark2022-06-06-4/+0
| | | | The values can effectively be set via the Gunicorn config instead.
* Accept NsJail arguments via the WSGI app (SnekAPI)Gravatar Mark2022-06-06-1/+4
|
* Remove GIT_SHA from README.mdGravatar MarkKoz2022-06-01-1/+0
| | | | The env var is no longer used anywhere.
* Replace ASCII diagram with mermaid sequence diagramGravatar Mark2022-03-12-14/+15
|
* Move community health files to .github dirGravatar MarkKoz2022-03-05-1/+1
| | | | Merge DEVELOPING.md into CONTRIBUTING.md
* master => mainGravatar Joe Banks2021-03-13-5/+5
|
* Document configuration thoroughlyGravatar MarkKoz2021-02-04-1/+41
|
* Move development environment guide to a separate fileGravatar MarkKoz2021-02-04-94/+1
| | | | | | The information is only relevant to developers. The README is what all users will read; they shouldn't be subject to information that isn't necessarily relevant to them.
* Merge PR #88 - use protobuf to parse configGravatar Mark2021-02-02-3/+3
|\
| * Fix typo in READMEGravatar Mark2021-01-14-1/+1
| |
| * Replace nsjpy alias with a Python scriptGravatar MarkKoz2021-01-10-3/+3
| | | | | | | | | | | | | | | | | | The Python script uses the same underlying code Falcon uses to invoke nsjail. It allows for the omission of redundant shell code that set up cgroups and nsjail args. This is also a step towards removing dependence on shell scripts and thus resolving #73.
* | Remove trailing whitespaces from the READMEGravatar Matteo Bertucci2021-01-22-1/+1
| |
* | Update the README badgesGravatar Matteo Bertucci2021-01-22-1/+6
| |
* | Fix caching of exposed packagesGravatar MarkKoz2021-01-12-6/+4
|/ | | | | | | | | | | | | | | The problem with --ignore-installed is that it also ignores packages in the target site, therefore re-installing all packages and making caching futile. Install snekbox's dependencies to the default user site. During installation of the exposed packages, switch the user site to a custom one to ensure pip will not skip packages due to seeing them as already installed as one of snekbox's dependencies. If pip made the --root option ignore packages outside the root, then using --root would be the best solution. There is a 5+ year old issue open about that.
* Removing trailing whitespaces from README.mdGravatar MarkKoz2021-01-09-1/+1
|
* Document how to install additional packagesGravatar MarkKoz2021-01-09-1/+22
|
* Document output truncation in READMEGravatar Sebastiaan Zeeff2020-11-20-0/+1
|
* Remove redundant build commands for PipfileGravatar Sebastiaan Zeeff2020-11-18-3/+1
| | | | | | I've removed the redundant intermediate image build commands from the Pipfile. Since everything is now contained in one Dockerfile, we can simply build the final image in one go.
* Migrate build pipeline to Github ActionsGravatar Sebastiaan Zeeff2020-11-18-7/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I've migrated the build pipeline to GitHub Actions and changed the container registry to GitHub Container Registry. In the process, I've made some changes to our docker setup and caching: - We are now using a single multi-stage Dockerfile Instead of three separate dockerfiles, we are now using a single multi-stage Dockerfile that can be used to build the three images we want using build targets. In part, this is because we're now using the docker buildx build action currently recommended by docker. This new engine runs in a sandboxed mode, meaning that while it can export built images to `docker` running in the host, it cannot import local images from it to base builds on. - Docker builds are now cached within GitHub Actions The builds are now cached using the GitHub Actions cache of the build cache directory. The cache keys try to match a cache generated by a build that matches the current build as closely as possible. In case of a cache miss, we fall back to caching from the latest image pushed to the container repository. - The `base` and `venv` images now have an inline cache manifest In order to fall back intelligently to caching from the repository, the final build and push action for the `base` and `venv` images includes an "inline" cache manifest. This means that the build process can inspect, without pulling, if it makes sense to pull layers to speed up the build. The other options, pushing a cache manifest separately (not inline), is currently not supported by GHCR. The custom caching script has been removed. - Linting errors are now added as GitHub Actions annotations Just like for some of our other pipelines, linting now generates annotations if linting errors are observed. - Coverage is pushed to coveralls.io A coverage summary is now pushed to coveralls.io. Each CI run will get a unique job that's linked in the CI output. If the run is attached to a PR, coveralls.io will automatically add a check link with the coverage result to the PR as well. - The README.md, Pipfile, docker-compose, and scripts have been updated As we now need to pull from and link to the GHCR, I've updated the other files to reflect these changes, including Pipfile run commands. I've also changed the CI badge and added a coveralls.io badge.
* add --dev flag to readmeGravatar Rasmus Moorats2020-03-29-1/+1
|
* Move snekbox.cfg to a config directoryGravatar MarkKoz2020-03-23-1/+1
| | | | | There will be more config files to come so it's cleaner to have them together than littering the root directory with more files.
* Fix a grammatical error in README.mdGravatar MarkKoz2020-03-23-1/+1
|
* Replace NsJail config details with a reference to snekbox.cfgGravatar MarkKoz2020-03-23-15/+2
| | | | | | As convenient as it may be, it is redundant to list out the config in the docs. It also may fall out of sync with the actual config should someone forget to update the docs.
* Use reference links in README.mdGravatar MarkKoz2020-03-23-7/+18
| | | | Makes the Markdown less cluttered when editing it.
* Document a simple way to run the container from Docker HubGravatar MarkKoz2020-03-23-0/+12
| | | | | | | | The current run instructions are geared towards developers. A simpler way to run snekbox is to start a container with `docker run` via the image published on Docker Hub. Resolves #57
* Increase time limit from 2 to 5 secondsGravatar Joseph Banks2020-01-24-1/+1
|
* Mount only what's needed in the chroot jailGravatar MarkKoz2019-12-28-1/+1
| | | | | | | | | | | | devfs and sysfs were problematic since they were being mounted as tmpfs, which is r/w. For example, the Python process could write to cgroups. Now, only what is needed to run Python gets mounted. This boils down to the venv itself and some shared libraries Python needs. * Use a config file for NsJail instead of command-line options * Map 65534 (nobody) user & group inside the user namespace to 65534 outside the namespace rather than mapping to current uid/guid (which was 0 AKA root)
* Use bash instead of ashGravatar MarkKoz2019-12-14-3/+3
| | | | Forgot to do this after switching to Debian.
* Update the Python version in READMEGravatar MarkKoz2019-12-14-2/+2
|
* Use pipenv sync instead of pipenv --syncGravatar Maku2019-10-05-1/+1
|
* Increase size of some headings in READMEGravatar MarkKoz2019-08-05-2/+2
|
* Add links to API docs in READMEGravatar MarkKoz2019-08-05-10/+13
| | | | | | | * Add a link to pipenv * Remove the "Details" section; now part of the first "snekbox" section * Clarify that snekbox uses a HTTP REST API * Document the default host and port for the webserver
* Fix grammar in READMEGravatar MarkKoz2019-08-04-2/+2
|
* Add Pipfile script and docs for building dev venv imageGravatar MarkKoz2019-08-04-1/+15
| | | | | | | | The builddev script will build just the dev venv image. The testb script will build the dev venv image, clean up dangling images, and then run tests. * Give the coverage commands their own header in the README
* Rewrite README and clean up Pipfile scriptsGravatar MarkKoz2019-08-04-63/+79
| | | | | | * Make the report script do the normal coverage report instead of HTML * Remove Docker image push scripts * Add image build script for the venv image
generated by cgit v1.2.3 (git 2.39.1) at 2025-10-19 02:52:56 +0000